From e80ea2eaef3681d17d62d3eb7d0853013edbc471 Mon Sep 17 00:00:00 2001 From: Nikolas Burkoff Date: Thu, 30 Jun 2022 10:01:26 +0100 Subject: [PATCH] export function (#524) --- NAMESPACE | 1 + R/labels.R | 10 +++++----- _pkgdown.yml | 1 + man/column_annotation_label.Rd | 9 ++++----- 4 files changed, 11 insertions(+), 10 deletions(-) diff --git a/NAMESPACE b/NAMESPACE index 787f3ef1d3..3a9345bca3 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -10,6 +10,7 @@ export(bracket_expr) export(call_concatenate) export(clean_description) export(color_lab_values) +export(column_annotation_label) export(cs_to_des_filter) export(cs_to_des_select) export(cs_to_filter_spec) diff --git a/R/labels.R b/R/labels.R index 05089ad9b8..036e8ce8f1 100644 --- a/R/labels.R +++ b/R/labels.R @@ -8,15 +8,15 @@ #' #' @examples #' data <- mtcars -#' teal.modules.clinical:::column_annotation_label(data, "cyl") +#' column_annotation_label(data, "cyl") #' attr(data[["cyl"]], "label") <- "Cylinder" -#' teal.modules.clinical:::column_annotation_label(data, "cyl") -#' teal.modules.clinical:::column_annotation_label(data, "cyl", omit_raw_name = TRUE) +#' column_annotation_label(data, "cyl") +#' column_annotation_label(data, "cyl", omit_raw_name = TRUE) #' \dontrun{ #' ANL <- scda::synthetic_cdisc_data("latest")$adsl -#' teal.modules.clinical:::column_annotation_label(ANL, "ACTARM") +#' column_annotation_label(ANL, "ACTARM") #' } -#' @keywords internal +#' @export column_annotation_label <- function(dataset, column, omit_raw_name = FALSE) { checkmate::assert_data_frame(dataset) checkmate::assert_string(column) diff --git a/_pkgdown.yml b/_pkgdown.yml index 919b432202..77c86d5ef9 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -32,6 +32,7 @@ reference: - call_concatenate - clean_description - color_lab_values + - column_annotation_label - cs_to_des_filter - cs_to_des_select - cs_to_filter_spec diff --git a/man/column_annotation_label.Rd b/man/column_annotation_label.Rd index c9ab422f63..ba652a6497 100644 --- a/man/column_annotation_label.Rd +++ b/man/column_annotation_label.Rd @@ -21,13 +21,12 @@ Get full label, useful for annotating plots } \examples{ data <- mtcars -teal.modules.clinical:::column_annotation_label(data, "cyl") +column_annotation_label(data, "cyl") attr(data[["cyl"]], "label") <- "Cylinder" -teal.modules.clinical:::column_annotation_label(data, "cyl") -teal.modules.clinical:::column_annotation_label(data, "cyl", omit_raw_name = TRUE) +column_annotation_label(data, "cyl") +column_annotation_label(data, "cyl", omit_raw_name = TRUE) \dontrun{ ANL <- scda::synthetic_cdisc_data("latest")$adsl -teal.modules.clinical:::column_annotation_label(ANL, "ACTARM") +column_annotation_label(ANL, "ACTARM") } } -\keyword{internal}