From 63e06150818f0c47d1a5ac8fdf62e2ad211990e3 Mon Sep 17 00:00:00 2001 From: Puzzled-Face Date: Wed, 5 Jun 2024 12:38:38 +0000 Subject: [PATCH 1/2] Add @method annotations --- NAMESPACE | 1 - R/helpers_knitr_CohortSize.R | 7 +++++++ R/helpers_knitr_GeneralData.R | 2 ++ R/helpers_knitr_Increments.R | 8 ++++++++ man/knit_print.Rd | 2 +- 5 files changed, 18 insertions(+), 2 deletions(-) diff --git a/NAMESPACE b/NAMESPACE index 997302dc8..e8d2cc256 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -8,7 +8,6 @@ S3method(knit_print,CohortSizeOrdinal) S3method(knit_print,CohortSizeParts) S3method(knit_print,CohortSizeRange) S3method(knit_print,DADesign) -S3method(knit_print,DataParts) S3method(knit_print,Design) S3method(knit_print,DesignGrouped) S3method(knit_print,DesignOrdinal) diff --git a/R/helpers_knitr_CohortSize.R b/R/helpers_knitr_CohortSize.R index 349abcdd8..a4b9edb18 100644 --- a/R/helpers_knitr_CohortSize.R +++ b/R/helpers_knitr_CohortSize.R @@ -30,6 +30,7 @@ NULL #' @seealso [`knit_print`] for more details. #' #' @export +#' @method knit_print CohortSizeConst #' @rdname knit_print knit_print.CohortSizeConst <- function(x, ..., asis = TRUE, label = c("participant", "participants")) { assert_flag(asis) @@ -53,6 +54,7 @@ knit_print.CohortSizeConst <- function(x, ..., asis = TRUE, label = c("participa #' These values can be overridden by passing `col.names` and `caption` in the #' function call. #' @export +#' @method knit_print CohortSizeRange #' @rdname knit_print knit_print.CohortSizeRange <- function(x, ..., asis = TRUE) { assert_flag(asis) @@ -91,6 +93,7 @@ knit_print.CohortSizeRange <- function(x, ..., asis = TRUE) { #' function call. #' #' @export +#' @method knit_print CohortSizeDLT #' @rdname knit_print knit_print.CohortSizeDLT <- function(x, ..., tox_label = "toxicity", asis = TRUE) { assert_flag(asis) @@ -125,6 +128,7 @@ knit_print.CohortSizeDLT <- function(x, ..., tox_label = "toxicity", asis = TRUE #' @inheritSection knit_print.CohortSizeConst Usage Notes #' #' @export +#' @method knit_print CohortSizeParts #' @rdname knit_print knit_print.CohortSizeParts <- function(x, ..., asis = TRUE, label = c("participant", "participants")) { assert_flag(asis) @@ -155,6 +159,7 @@ knit_print.CohortSizeParts <- function(x, ..., asis = TRUE, label = c("participa #' rules #' #' @export +#' @method knit_print CohortSizeMax #' @rdname knit_print knit_print.CohortSizeMax <- function(x, ..., asis = TRUE) { assert_flag(asis) @@ -190,6 +195,7 @@ knit_print.CohortSizeMax <- function(x, ..., asis = TRUE) { #' rules #' #' @export +#' @method knit_print CohortSizeMin #' @rdname knit_print knit_print.CohortSizeMin <- function(x, ..., asis = TRUE) { assert_flag(asis) @@ -220,6 +226,7 @@ knit_print.CohortSizeMin <- function(x, ..., asis = TRUE) { #' @param ... passed through to the `knit_print` method of the standard rule #' #' @export +#' @method knit_print CohortSizeOrdinal #' @rdname knit_print knit_print.CohortSizeOrdinal <- function(x, ..., tox_label = "toxicity", asis = TRUE) { assert_flag(asis) diff --git a/R/helpers_knitr_GeneralData.R b/R/helpers_knitr_GeneralData.R index 1f2653a1b..dc81a1020 100644 --- a/R/helpers_knitr_GeneralData.R +++ b/R/helpers_knitr_GeneralData.R @@ -321,6 +321,7 @@ h_knit_print_summarise.DataGrouped <- function(x, summarise, full_grid, ...) { #' #' @inheritParams h_get_formatted_dosegrid #' @export +#' @method knit_print GeneralData #' @rdname knit_print knit_print.GeneralData <- function( x, ..., asis = TRUE, @@ -384,6 +385,7 @@ knit_print.GeneralData <- function( } #' @export +#' @method knit_print GeneralData #' @rdname knit_print knit_print.DataParts <- function( x, ..., asis = TRUE, diff --git a/R/helpers_knitr_Increments.R b/R/helpers_knitr_Increments.R index eea4b7465..d7fc4f3d7 100644 --- a/R/helpers_knitr_Increments.R +++ b/R/helpers_knitr_Increments.R @@ -14,6 +14,7 @@ #' values can be overridden by passing `col.names` and `caption` in the function #' call. #' @export +#' @method knit_print IncrementsRelative #' @rdname knit_print knit_print.IncrementsRelative <- function(x, ..., asis = TRUE) { assert_flag(asis) @@ -50,6 +51,7 @@ knit_print.IncrementsRelative <- function(x, ..., asis = TRUE) { #' of `caption` is `"Defined by number of DLTs reported so far"`. These values #' can be overridden by passing `col.names` and `caption` in the function call. #' @export +#' @method knit_print IncrementsRelativeDLT #' @rdname knit_print knit_print.IncrementsRelativeDLT <- function(x, ..., asis = TRUE) { assert_flag(asis) @@ -83,6 +85,7 @@ knit_print.IncrementsRelativeDLT <- function(x, ..., asis = TRUE) { #' @inheritParams knit_print.CohortSizeConst #' @export #' @rdname knit_print +#' @method knit_print IncrementsDoseLevels knit_print.IncrementsDoseLevels <- function(x, ..., asis = TRUE) { assert_flag(asis) @@ -107,6 +110,7 @@ knit_print.IncrementsDoseLevels <- function(x, ..., asis = TRUE) { #' @inherit knit_print.CohortSizeConst return #' @inheritParams knit_print.CohortSizeConst #' @export +#' @method knit_print IncrementsHSRBeta #' @rdname knit_print knit_print.IncrementsHSRBeta <- function(x, ..., asis = TRUE) { assert_flag(asis) @@ -135,6 +139,7 @@ knit_print.IncrementsHSRBeta <- function(x, ..., asis = TRUE) { #' rules #' @inheritParams knit_print.CohortSizeConst #' @export +#' @method knit_print IncrementsMin #' @rdname knit_print knit_print.IncrementsMin <- function(x, ..., asis = TRUE) { assert_flag(asis) @@ -165,6 +170,7 @@ knit_print.IncrementsMin <- function(x, ..., asis = TRUE) { #' @param ... passed through to the `knit_print` method of the standard rule #' @inheritParams knit_print.CohortSizeConst #' @export +#' @method knit_print IncrementsOrdinal #' @rdname knit_print knit_print.IncrementsOrdinal <- function(x, ..., asis = TRUE) { assert_flag(asis) @@ -199,6 +205,7 @@ knit_print.IncrementsOrdinal <- function(x, ..., asis = TRUE) { #' describing a single toxicity. #' #' @export +#' @method knit_print IncrementsRelativeParts #' @rdname knit_print knit_print.IncrementsRelativeParts <- function(x, ..., asis = TRUE, tox_label = c("toxicity", "toxicities")) { assert_flag(asis) @@ -284,6 +291,7 @@ knit_print.IncrementsRelativeParts <- function(x, ..., asis = TRUE, tox_label = #' describing a single toxicity. #' #' @export +#' @method knit_print IncrementsRelativeDLTCurrent #' @rdname knit_print knit_print.IncrementsRelativeDLTCurrent <- function( x, diff --git a/man/knit_print.Rd b/man/knit_print.Rd index 982b8d1cd..2aee5498c 100644 --- a/man/knit_print.Rd +++ b/man/knit_print.Rd @@ -148,7 +148,7 @@ format_func = function(x) x ) -\method{knit_print}{DataParts}( +\method{knit_print}{GeneralData}( x, ..., asis = TRUE, From c53c6a9d0540cc73509108eeb6ce27d701eaeae9 Mon Sep 17 00:00:00 2001 From: Puzzled-Face Date: Wed, 5 Jun 2024 13:49:07 +0000 Subject: [PATCH 2/2] Fix typo --- NAMESPACE | 1 + R/helpers_knitr_GeneralData.R | 2 +- man/knit_print.Rd | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/NAMESPACE b/NAMESPACE index e8d2cc256..997302dc8 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -8,6 +8,7 @@ S3method(knit_print,CohortSizeOrdinal) S3method(knit_print,CohortSizeParts) S3method(knit_print,CohortSizeRange) S3method(knit_print,DADesign) +S3method(knit_print,DataParts) S3method(knit_print,Design) S3method(knit_print,DesignGrouped) S3method(knit_print,DesignOrdinal) diff --git a/R/helpers_knitr_GeneralData.R b/R/helpers_knitr_GeneralData.R index dc81a1020..8a0082241 100644 --- a/R/helpers_knitr_GeneralData.R +++ b/R/helpers_knitr_GeneralData.R @@ -385,7 +385,7 @@ knit_print.GeneralData <- function( } #' @export -#' @method knit_print GeneralData +#' @method knit_print DataParts #' @rdname knit_print knit_print.DataParts <- function( x, ..., asis = TRUE, diff --git a/man/knit_print.Rd b/man/knit_print.Rd index 2aee5498c..982b8d1cd 100644 --- a/man/knit_print.Rd +++ b/man/knit_print.Rd @@ -148,7 +148,7 @@ format_func = function(x) x ) -\method{knit_print}{GeneralData}( +\method{knit_print}{DataParts}( x, ..., asis = TRUE,