diff --git a/DESCRIPTION b/DESCRIPTION index 2b08238..21d931c 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -36,5 +36,4 @@ Config/testthat/edition: 3 Encoding: UTF-8 Language: en-US Roxygen: list(markdown = TRUE) -Config/roxygen2/version: 8.0.0 -RoxygenNote: 7.3.3 +Config/roxygen2/version: 8.1.0 diff --git a/NAMESPACE b/NAMESPACE index 53633f9..d6bcc35 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -10,15 +10,23 @@ importFrom(S7,convert) importFrom(callr,r) importFrom(grDevices,grSoftVersion) importFrom(methods,is) -importFrom(quarto,quarto_render) -importFrom(quarto,quarto_version) -importFrom(tools,check_packages_in_dir_details) -importFrom(tools,file_ext) -importFrom(utils,capture.output) -importFrom(utils,head) -importFrom(utils,packageName) -importFrom(utils,sessionInfo) -importFrom(utils,tail) -importFrom(val.meter,metrics) -importFrom(val.meter,pkg) +importFrom(quarto, + quarto_render, + quarto_version +) +importFrom(tools, + check_packages_in_dir_details, + file_ext +) +importFrom(utils, + capture.output, + head, + packageName, + sessionInfo, + tail +) +importFrom(val.meter, + metrics, + pkg +) importFrom(yaml,yaml.load) diff --git a/R/reporter.R b/R/reporter.R index 72acf8c..0dfbd0b 100644 --- a/R/reporter.R +++ b/R/reporter.R @@ -23,7 +23,7 @@ #' @param quiet `logical(1L)` flag indicating whether output should be emitted #' to the console when rendering the report. #' @param ... Additional arguments passed to [quarto::quarto_render()] -#' +#' @returns Path to the reports. #' @examples #' \dontrun{ #' options( diff --git a/R/session.R b/R/session.R index 901ccf1..af67889 100644 --- a/R/session.R +++ b/R/session.R @@ -4,7 +4,12 @@ #' #' @importFrom grDevices grSoftVersion #' @importFrom utils sessionInfo +#' @returns A list with time, r_version, session_info, platform, machine, +#' rng_kind, capabilities, external_software and graphics_software information. #' @export +#' @examples +#' s <- session() +#' str(s, 2) session <- function() { # NOTE: data that is provided as named character vectors are coerced to # lists because the names otherwise get lost when passed as a quarto parameter diff --git a/R/utils-knitr.R b/R/utils-knitr.R index 724dbb7..54cf176 100644 --- a/R/utils-knitr.R +++ b/R/utils-knitr.R @@ -210,6 +210,8 @@ knit_print.knitr_log <- local({ #' be printed, mark them as "AsIs" using [I()]. #' #' @export +#' @examples +#' knitr_logger() knitr_logger <- local({ first_chunk_log <- TRUE style <- knitr_logger_styles diff --git a/inst/WORDLIST b/inst/WORDLIST index 9c40780..792c36f 100644 --- a/inst/WORDLIST +++ b/inst/WORDLIST @@ -1,7 +1,12 @@ +AsIs +CMD Codecov -Hoffmann ORCID Revilla -Vectorize -funder +Submodules +knitr +pre riskmetric +rng +serializable +submodule diff --git a/man/knitr_logger.Rd b/man/knitr_logger.Rd index f56f755..592b965 100644 --- a/man/knitr_logger.Rd +++ b/man/knitr_logger.Rd @@ -20,3 +20,6 @@ messages to the console during knitting. \note{ \code{val.report} \code{knitr} utilities are exported for use in reports maintained by the R Validation Hub. If you choose to use these functions for other purposes, be aware that these are not considered stable for broader use. } +\examples{ +knitr_logger() +} diff --git a/man/knitr_logger_styles.Rd b/man/knitr_logger_styles.Rd index 04dbfad..8ac73e3 100644 --- a/man/knitr_logger_styles.Rd +++ b/man/knitr_logger_styles.Rd @@ -1,16 +1,11 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/utils-knitr.R -\docType{data} \name{knitr_logger_styles} \alias{knitr_logger_styles} \title{Various elements used for tailoring output style to command-line utility} -\format{ -An object of class \code{list} of length 2. -} \usage{ knitr_logger_styles } \description{ Various elements used for tailoring output style to command-line utility } -\keyword{datasets} diff --git a/man/package_report.Rd b/man/package_report.Rd index 6452f9e..393eae6 100644 --- a/man/package_report.Rd +++ b/man/package_report.Rd @@ -39,6 +39,9 @@ to the console when rendering the report.} \item{...}{Additional arguments passed to \code{\link[quarto:quarto_render]{quarto::quarto_render()}}} } +\value{ +Path to the reports. +} \description{ Generates an R Validation Hub package report } diff --git a/man/session.Rd b/man/session.Rd index 4087b94..e795406 100644 --- a/man/session.Rd +++ b/man/session.Rd @@ -6,6 +6,14 @@ \usage{ session() } +\value{ +A list with time, r_version, session_info, platform, machine, +rng_kind, capabilities, external_software and graphics_software information. +} \description{ Catalogs characteristics of the R session and execution environment. } +\examples{ +s <- session() +str(s, 2) +} diff --git a/man/val.report-package.Rd b/man/val.report-package.Rd index c42622a..a6115af 100644 --- a/man/val.report-package.Rd +++ b/man/val.report-package.Rd @@ -6,6 +6,8 @@ \alias{val.report-package} \title{val.report: Validation Reports} \description{ +\if{html}{\figure{logo.svg}{options: style='float: right' alt='logo' width='120'}} + Documents package checks for validation in a pharmaceutic context. } \seealso{ @@ -20,6 +22,11 @@ Useful links: \author{ \strong{Maintainer}: Lluís Revilla Sancho \email{lluis.revilla_sancho@roche.com} (\href{https://orcid.org/0000-0001-9747-2570}{ORCID}) +Authors: +\itemize{ + \item Lluís Revilla Sancho \email{lluis.revilla_sancho@roche.com} (\href{https://orcid.org/0000-0001-9747-2570}{ORCID}) +} + Other contributors: \itemize{ \item R Validation Hub \email{r-val-hub-maintainers@lists.r-consortium.org} [copyright holder]