From 1d48ab34b5e6fcce9641707f3e72611ab5c983fe Mon Sep 17 00:00:00 2001 From: Cara Andrews Date: Mon, 24 Jun 2024 08:59:56 +0000 Subject: [PATCH] updates to resolve check errors --- NEWS.md | 2 +- R/process_cut.R | 4 ++-- R/read_out.R | 6 +++--- man/process_cut.Rd | 4 ++-- man/read_out.Rd | 6 +++--- renv.lock | 11 +++++++---- 6 files changed, 18 insertions(+), 15 deletions(-) diff --git a/NEWS.md b/NEWS.md index 7a0fc35..acbcf31 100644 --- a/NEWS.md +++ b/NEWS.md @@ -2,7 +2,7 @@ ## New Features - Added a "Report a bug" link to `{datacutr}` website (#182) -- Added a `read_out` function that enables the generation of a read-out file (.html), to summarise changes applied to data during a datacut. (#107) +- Added a `read_out` function that enables the generation of a read-out file (.html), to summarize changes applied to data during a datacut. (#107) ## Updates of Existing Functions - Update to `impute_dcutdtc()`, `date_cut()` and `special_dm_cut()` functions to allow for diff --git a/R/process_cut.R b/R/process_cut.R index 427ac64..a3111e8 100644 --- a/R/process_cut.R +++ b/R/process_cut.R @@ -4,7 +4,7 @@ #' SDTMv date variable, and outputs the resulting cut datasets, as well as the datacut dataset, #' as a list. It provides an option to perform a "special" cut on the demography (dm) domain #' in which any deaths occurring after the datacut date are removed. It also provides an option -#' to produce a .html file that summarises the changes applied to the data during the cut, where +#' to produce a .html file that summarizes the changes applied to the data during the cut, where #' you can inspect the records that have been removed and/or modified. #' #' @param source_sdtm_data A list of uncut SDTMv dataframes @@ -25,7 +25,7 @@ #' produced. If `TRUE`, a .html file will be returned containing a summary of the cut and #' records removed. Default set to `FALSE`. #' @param out_path A character vector of file save path for the summary file if `read_out = TRUE`; -#' the default corresponds to the working directory, getwd(). +#' the default corresponds to the working directory, `getwd()`. #' #' @return Returns a list of all input SDTMv datasets, plus the datacut dataset, after #' performing the selected datacut on each SDTMv domain. diff --git a/R/read_out.R b/R/read_out.R index a02d56a..7a0bf92 100644 --- a/R/read_out.R +++ b/R/read_out.R @@ -1,6 +1,6 @@ #' @title Function to generate datacut summary file #' -#' @description Produces a .html file summarising the changes applied to data during a data cut. +#' @description Produces a .html file summarizing the changes applied to data during a data cut. #' The file will contain an overview for the change in number of records for each dataset, the types #' of cut applied and the opportunity to inspect the removed records. #' @@ -17,9 +17,9 @@ #' @param no_cut_list List of of quoted SDTMv domain names in which no cut should be applied. To be #' left blank if no domains are to remain exactly as source. #' @param out_path A character vector of file save path for the summary file; -#' the default corresponds to the working directory, getwd(). +#' the default corresponds to the working directory, `getwd()`. #' -#' @return Returns a .html file summarising the changes made to data during a datacut. +#' @return Returns a .html file summarizing the changes made to data during a datacut. #' #' @export #' diff --git a/man/process_cut.Rd b/man/process_cut.Rd index 53fbb82..d7e8809 100644 --- a/man/process_cut.Rd +++ b/man/process_cut.Rd @@ -43,7 +43,7 @@ produced. If \code{TRUE}, a .html file will be returned containing a summary of records removed. Default set to \code{FALSE}.} \item{out_path}{A character vector of file save path for the summary file if \code{read_out = TRUE}; -the default corresponds to the working directory, getwd().} +the default corresponds to the working directory, \code{getwd()}.} } \value{ Returns a list of all input SDTMv datasets, plus the datacut dataset, after @@ -54,7 +54,7 @@ Applies the selected type of datacut on each SDTMv dataset based on the chosen SDTMv date variable, and outputs the resulting cut datasets, as well as the datacut dataset, as a list. It provides an option to perform a "special" cut on the demography (dm) domain in which any deaths occurring after the datacut date are removed. It also provides an option -to produce a .html file that summarises the changes applied to the data during the cut, where +to produce a .html file that summarizes the changes applied to the data during the cut, where you can inspect the records that have been removed and/or modified. } \examples{ diff --git a/man/read_out.Rd b/man/read_out.Rd index dad504f..842a68f 100644 --- a/man/read_out.Rd +++ b/man/read_out.Rd @@ -32,13 +32,13 @@ the variables DCUT_TEMP_REMOVE and DCUT_TEMP_DTHCHANGE.} left blank if no domains are to remain exactly as source.} \item{out_path}{A character vector of file save path for the summary file; -the default corresponds to the working directory, getwd().} +the default corresponds to the working directory, \code{getwd()}.} } \value{ -Returns a .html file summarising the changes made to data during a datacut. +Returns a .html file summarizing the changes made to data during a datacut. } \description{ -Produces a .html file summarising the changes applied to data during a data cut. +Produces a .html file summarizing the changes applied to data during a data cut. The file will contain an overview for the change in number of records for each dataset, the types of cut applied and the opportunity to inspect the removed records. } diff --git a/renv.lock b/renv.lock index b227cb9..2e8c259 100644 --- a/renv.lock +++ b/renv.lock @@ -2,10 +2,6 @@ "R": { "Version": "4.3.1", "Repositories": [ - { - "Name": "NON_VALIDATED", - "URL": "https://packages.roche.com/Non-Validated/2023-10-09+8Fbwf0T6" - }, { "Name": "CRAN", "URL": "https://packages.roche.com/CRAN/2023-10-10" @@ -796,6 +792,13 @@ ], "Hash": "76c9e04c712a05848ae7a23d2f170a40" }, + "remotes": { + "Package": "remotes", + "Version": "2.4.2", + "Source": "Repository", + "Repository": "CRAN", + "Hash": "57c3009534f805f0f6476ffee68483cc" + }, "renv": { "Package": "renv", "Version": "1.0.3",