Skip to content

Commit

Permalink
[skip vbump] upversion v0.7.0 (#364)
Browse files Browse the repository at this point in the history
Fixes #358

### Summary
* Update NEWS
* Update DESCRIPTION
  * Temporary removal of Remotes
  * Upversion teal.code to `0.6.0`
* Update deprecation message to version `0.7.0`
* Update `teal_data` roxygen docs for missing links
  • Loading branch information
donyunardi authored Jan 28, 2025
1 parent 3fa034b commit 29deac2
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 19 deletions.
8 changes: 3 additions & 5 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Type: Package
Package: teal.data
Title: Data Model for 'teal' Applications
Version: 0.6.0.9027
Date: 2025-01-24
Version: 0.7.0
Date: 2025-01-27
Authors@R: c(
person("Dawid", "Kaledkowski", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "0000-0001-9533-457X")),
Expand All @@ -29,7 +29,7 @@ URL: https://insightsengineering.github.io/teal.data/,
BugReports: https://github.com/insightsengineering/teal.data/issues
Depends:
R (>= 4.0),
teal.code (>= 0.5.0.9015)
teal.code (>= 0.6.0)
Imports:
checkmate (>= 2.1.0),
lifecycle (>= 0.2.0),
Expand All @@ -47,8 +47,6 @@ VignetteBuilder:
rmarkdown
RdMacros:
lifecycle
Remotes:
insightsengineering/teal.code
Config/Needs/verdepcheck: insightsengineering/teal.code, mllg/checkmate,
r-lib/lifecycle, r-lib/rlang, yihui/knitr, rstudio/rmarkdown,
r-lib/testthat, r-lib/withr
Expand Down
3 changes: 1 addition & 2 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# teal.data 0.6.0.9027
# teal.data 0.7.0

### Breaking changes

Expand All @@ -7,7 +7,6 @@
- Deprecate of `datanames(x) <- value`. Does nothing, replace with renaming the objects inside the environment.
- All parameters and functions deprecated on 0.4.0 were removed.


### Enhancements

- `names()` function is introduced replacing `datanames`.
Expand Down
6 changes: 3 additions & 3 deletions R/deprecated.R
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
#' @export
datanames <- function(x) {
lifecycle::deprecate_soft(
when = "0.6.1",
when = "0.7.0",
what = "datanames()",
with = "names()"
)
Expand All @@ -31,7 +31,7 @@ datanames <- function(x) {
#' @export
`datanames<-` <- function(x, value) {
lifecycle::deprecate_soft(
when = "0.6.1",
when = "0.7.0",
what = "`datanames<-`()",
details = "invalid to use `datanames()<-` or `names()<-` on an object of class `teal_data`. See ?names.teal_data"
)
Expand All @@ -43,7 +43,7 @@ datanames <- function(x) {
#' @keywords internal
`names<-.teal_data` <- function(x, value) {
lifecycle::deprecate_warn(
when = "0.6.1",
when = "0.7.0",
what = "`names<-.teal_data`()",
details = "invalid to use `datanames()<-` or `names()<-` on an object of class `teal_data`. See ?names.teal_data"
)
Expand Down
8 changes: 4 additions & 4 deletions R/teal_data-constructor.R
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,22 @@
#' @details
#'
#' A `teal_data` is meant to be used for reproducibility purposes. The class inherits from
#' [`teal.data::qenv`] and we encourage to get familiar with \CRANpkg{teal.code} first.
#' [`teal.code::qenv`] and we encourage to get familiar with \CRANpkg{teal.code} first.
#' `teal_data` has following characteristics:
#'
#' - It inherits from the environment and methods such as [`$`], [get()], [ls()], [as.list()],
#' [parent.env()] work out of the box.
#' - `teal_data` is a locked environment, and data modification is only possible through the
#' [teal.code::eval_code()] and [within.qenv()] functions.
#' - It stores metadata about the code used to create the data (see [get_code()]).
#' [teal.code::eval_code()] and [`within.qenv()`][teal.code::within.qenv()] functions.
#' - It stores metadata about the code used to create the data (see [`get_code()`][get_code,teal_data-method]).
#' - It supports slicing (see [`teal.code::subset-qenv`])
#' - Is immutable which means that each code evaluation does not modify the original `teal_data`
#' environment directly.
#' - It maintains information about relationships between datasets (see [join_keys()]).
#'
#' @return A `teal_data` object.
#'
#' @seealso [`teal.code::eval_code`], [get_code()], [join_keys()], [names.teal_data()]
#' @seealso [`teal.code::eval_code`], [`get_code()`][get_code,teal_data-method], [join_keys()], [names.teal_data()]
#'
#' @export
#'
Expand Down
2 changes: 1 addition & 1 deletion R/teal_data-get_code.R
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ setMethod("get_code",
definition = function(object, deparse = TRUE, names = NULL, datanames = lifecycle::deprecated(), ...) {
if (lifecycle::is_present(datanames)) {
lifecycle::deprecate_warn(
when = "0.6.1",
when = "0.7.0",
what = "teal.data::get_code(datanames)",
with = "teal.code::get_code(names)",
always = TRUE
Expand Down
8 changes: 4 additions & 4 deletions man/teal_data.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 29deac2

Please sign in to comment.