From 4586ed39b795ec23c77ab935701a0db37dda8c2f Mon Sep 17 00:00:00 2001 From: Dony Unardi Date: Mon, 27 Jan 2025 16:19:24 -0800 Subject: [PATCH 1/6] [skip vbump] upversion v0.7.0 --- DESCRIPTION | 8 +++----- NEWS.md | 3 +-- R/deprecated.R | 6 +++--- R/teal_data-get_code.R | 2 +- 4 files changed, 8 insertions(+), 11 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index a9f7f16ae..168bc00ea 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -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", , "dawid.kaledkowski@roche.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-9533-457X")), @@ -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), @@ -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 diff --git a/NEWS.md b/NEWS.md index 95f4cf23b..99e93c378 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# teal.data 0.6.0.9027 +# teal.data 0.7.0 ### Breaking changes @@ -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`. diff --git a/R/deprecated.R b/R/deprecated.R index a7da1c2ab..43abb6421 100644 --- a/R/deprecated.R +++ b/R/deprecated.R @@ -20,7 +20,7 @@ #' @export datanames <- function(x) { lifecycle::deprecate_soft( - when = "0.6.1", + when = "0.7.0", what = "datanames()", with = "names()" ) @@ -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" ) @@ -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" ) diff --git a/R/teal_data-get_code.R b/R/teal_data-get_code.R index 52c237a71..8ebebd56f 100644 --- a/R/teal_data-get_code.R +++ b/R/teal_data-get_code.R @@ -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 From 232d553fc091800f555164aaf7baa5bea15c8d71 Mon Sep 17 00:00:00 2001 From: Dony Unardi Date: Mon, 27 Jan 2025 16:50:00 -0800 Subject: [PATCH 2/6] add package anchor for qenv and within.qenv --- R/teal_data-constructor.R | 4 ++-- man/teal_data.Rd | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/R/teal_data-constructor.R b/R/teal_data-constructor.R index 8168bd457..451cf440e 100644 --- a/R/teal_data-constructor.R +++ b/R/teal_data-constructor.R @@ -19,13 +19,13 @@ #' @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. +#' [teal.code::eval_code()] and [teal.code::within.qenv()] functions. #' - It stores metadata about the code used to create the data (see [get_code()]). #' - It supports slicing (see [`teal.code::subset-qenv`]) #' - Is immutable which means that each code evaluation does not modify the original `teal_data` diff --git a/man/teal_data.Rd b/man/teal_data.Rd index a142c2b1e..79f20514b 100644 --- a/man/teal_data.Rd +++ b/man/teal_data.Rd @@ -35,13 +35,13 @@ Initializes a data for \code{teal} application. } \details{ A \code{teal_data} is meant to be used for reproducibility purposes. The class inherits from -\code{\link{qenv}} and we encourage to get familiar with \CRANpkg{teal.code} first. +\code{\link[teal.code:qenv]{teal.code::qenv}} and we encourage to get familiar with \CRANpkg{teal.code} first. \code{teal_data} has following characteristics: \itemize{ \item It inherits from the environment and methods such as \code{\link{$}}, \code{\link[=get]{get()}}, \code{\link[=ls]{ls()}}, \code{\link[=as.list]{as.list()}}, \code{\link[=parent.env]{parent.env()}} work out of the box. \item \code{teal_data} is a locked environment, and data modification is only possible through the -\code{\link[teal.code:eval_code]{teal.code::eval_code()}} and \code{\link[=within.qenv]{within.qenv()}} functions. +\code{\link[teal.code:eval_code]{teal.code::eval_code()}} and \code{\link[teal.code:eval_code]{teal.code::within.qenv()}} functions. \item It stores metadata about the code used to create the data (see \code{\link[=get_code]{get_code()}}). \item It supports slicing (see \code{\link[teal.code:subset-qenv]{teal.code::subset-qenv}}) \item Is immutable which means that each code evaluation does not modify the original \code{teal_data} From cb1afe00776916629a11d150574ccb588ad95c78 Mon Sep 17 00:00:00 2001 From: Dony Unardi Date: Mon, 27 Jan 2025 17:05:04 -0800 Subject: [PATCH 3/6] add anchor link for teal_data's get_code --- R/teal_data-constructor.R | 4 ++-- man/teal_data.Rd | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/R/teal_data-constructor.R b/R/teal_data-constructor.R index 451cf440e..d9e9d3eca 100644 --- a/R/teal_data-constructor.R +++ b/R/teal_data-constructor.R @@ -26,7 +26,7 @@ #' [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 [teal.code::within.qenv()] functions. -#' - It stores metadata about the code used to create the data (see [get_code()]). +#' - It stores metadata about the code used to create the data (see [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. @@ -34,7 +34,7 @@ #' #' @return A `teal_data` object. #' -#' @seealso [`teal.code::eval_code`], [get_code()], [join_keys()], [names.teal_data()] +#' @seealso [`teal.code::eval_code`], [get_code,teal_data-method], [join_keys()], [names.teal_data()] #' #' @export #' diff --git a/man/teal_data.Rd b/man/teal_data.Rd index 79f20514b..301aa8910 100644 --- a/man/teal_data.Rd +++ b/man/teal_data.Rd @@ -42,7 +42,7 @@ A \code{teal_data} is meant to be used for reproducibility purposes. The class i \code{\link[=parent.env]{parent.env()}} work out of the box. \item \code{teal_data} is a locked environment, and data modification is only possible through the \code{\link[teal.code:eval_code]{teal.code::eval_code()}} and \code{\link[teal.code:eval_code]{teal.code::within.qenv()}} functions. -\item It stores metadata about the code used to create the data (see \code{\link[=get_code]{get_code()}}). +\item It stores metadata about the code used to create the data (see \link{get_code,teal_data-method}). \item It supports slicing (see \code{\link[teal.code:subset-qenv]{teal.code::subset-qenv}}) \item Is immutable which means that each code evaluation does not modify the original \code{teal_data} environment directly. @@ -73,5 +73,5 @@ join_keys(data)["b"] } \seealso{ -\code{\link[teal.code:eval_code]{teal.code::eval_code}}, \code{\link[=get_code]{get_code()}}, \code{\link[=join_keys]{join_keys()}}, \code{\link[=names.teal_data]{names.teal_data()}} +\code{\link[teal.code:eval_code]{teal.code::eval_code}}, \link{get_code,teal_data-method}, \code{\link[=join_keys]{join_keys()}}, \code{\link[=names.teal_data]{names.teal_data()}} } From 627a72048e19e809b6cd07fc4efdd956bea81cd5 Mon Sep 17 00:00:00 2001 From: Dony Unardi Date: Tue, 28 Jan 2025 07:51:43 -0800 Subject: [PATCH 4/6] Update R/teal_data-constructor.R MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Dawid Kałędkowski Signed-off-by: Dony Unardi --- R/teal_data-constructor.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R/teal_data-constructor.R b/R/teal_data-constructor.R index d9e9d3eca..f3e667c33 100644 --- a/R/teal_data-constructor.R +++ b/R/teal_data-constructor.R @@ -26,7 +26,7 @@ #' [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 [teal.code::within.qenv()] functions. -#' - It stores metadata about the code used to create the data (see [get_code,teal_data-method]). +#' - 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. From dfc3c1d54dc26143ba0df9a2856487d30276e0ee Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 28 Jan 2025 15:54:58 +0000 Subject: [PATCH 5/6] [skip roxygen] [skip vbump] Roxygen Man Pages Auto Update --- man/teal_data.Rd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/man/teal_data.Rd b/man/teal_data.Rd index 301aa8910..4ca7017d8 100644 --- a/man/teal_data.Rd +++ b/man/teal_data.Rd @@ -42,7 +42,7 @@ A \code{teal_data} is meant to be used for reproducibility purposes. The class i \code{\link[=parent.env]{parent.env()}} work out of the box. \item \code{teal_data} is a locked environment, and data modification is only possible through the \code{\link[teal.code:eval_code]{teal.code::eval_code()}} and \code{\link[teal.code:eval_code]{teal.code::within.qenv()}} functions. -\item It stores metadata about the code used to create the data (see \link{get_code,teal_data-method}). +\item It stores metadata about the code used to create the data (see \link[=get_code,teal_data-method]{get_code()}). \item It supports slicing (see \code{\link[teal.code:subset-qenv]{teal.code::subset-qenv}}) \item Is immutable which means that each code evaluation does not modify the original \code{teal_data} environment directly. From 427e186f9f44aa361104e7f902187dc5f6c1665d Mon Sep 17 00:00:00 2001 From: Dony Unardi Date: Tue, 28 Jan 2025 08:46:18 -0800 Subject: [PATCH 6/6] update display for get_code and within --- R/teal_data-constructor.R | 6 +++--- man/teal_data.Rd | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/R/teal_data-constructor.R b/R/teal_data-constructor.R index f3e667c33..25a705342 100644 --- a/R/teal_data-constructor.R +++ b/R/teal_data-constructor.R @@ -25,8 +25,8 @@ #' - 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 [teal.code::within.qenv()] functions. -#' - It stores metadata about the code used to create the data (see [get_code()][get_code,teal_data-method]). +#' [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. @@ -34,7 +34,7 @@ #' #' @return A `teal_data` object. #' -#' @seealso [`teal.code::eval_code`], [get_code,teal_data-method], [join_keys()], [names.teal_data()] +#' @seealso [`teal.code::eval_code`], [`get_code()`][get_code,teal_data-method], [join_keys()], [names.teal_data()] #' #' @export #' diff --git a/man/teal_data.Rd b/man/teal_data.Rd index 4ca7017d8..a53804d60 100644 --- a/man/teal_data.Rd +++ b/man/teal_data.Rd @@ -41,8 +41,8 @@ A \code{teal_data} is meant to be used for reproducibility purposes. The class i \item It inherits from the environment and methods such as \code{\link{$}}, \code{\link[=get]{get()}}, \code{\link[=ls]{ls()}}, \code{\link[=as.list]{as.list()}}, \code{\link[=parent.env]{parent.env()}} work out of the box. \item \code{teal_data} is a locked environment, and data modification is only possible through the -\code{\link[teal.code:eval_code]{teal.code::eval_code()}} and \code{\link[teal.code:eval_code]{teal.code::within.qenv()}} functions. -\item It stores metadata about the code used to create the data (see \link[=get_code,teal_data-method]{get_code()}). +\code{\link[teal.code:eval_code]{teal.code::eval_code()}} and \code{\link[teal.code:eval_code]{within.qenv()}} functions. +\item It stores metadata about the code used to create the data (see \code{\link[=get_code,teal_data-method]{get_code()}}). \item It supports slicing (see \code{\link[teal.code:subset-qenv]{teal.code::subset-qenv}}) \item Is immutable which means that each code evaluation does not modify the original \code{teal_data} environment directly. @@ -73,5 +73,5 @@ join_keys(data)["b"] } \seealso{ -\code{\link[teal.code:eval_code]{teal.code::eval_code}}, \link{get_code,teal_data-method}, \code{\link[=join_keys]{join_keys()}}, \code{\link[=names.teal_data]{names.teal_data()}} +\code{\link[teal.code:eval_code]{teal.code::eval_code}}, \code{\link[=get_code,teal_data-method]{get_code()}}, \code{\link[=join_keys]{join_keys()}}, \code{\link[=names.teal_data]{names.teal_data()}} }