Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add @method annotations #827

Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
7 changes: 7 additions & 0 deletions R/helpers_knitr_CohortSize.R
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 2 additions & 0 deletions R/helpers_knitr_GeneralData.R
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -384,6 +385,7 @@ knit_print.GeneralData <- function(
}

#' @export
#' @method knit_print GeneralData
#' @rdname knit_print
knit_print.DataParts <- function(
x, ..., asis = TRUE,
Expand Down
8 changes: 8 additions & 0 deletions R/helpers_knitr_Increments.R
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)

Expand All @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion man/knit_print.Rd

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

Loading