added atributes ard

DESCRIPTION

@@ -18,7 +18,7 @@ BugReports: https://github.com/insightsengineering/cardx/issues
 Depends:
     R (>= 4.1)
 Imports:
-    cards (>= 0.1.0.9025),
+    cards (>= 0.1.0.9026),
     cli (>= 3.6.1),
     dplyr (>= 1.1.2),
     glue (>= 1.6.2),
@@ -33,13 +33,13 @@ Suggests:
     effectsize (>= 0.6.0),
     emmeans (>= 1.7.3),
     geepack (>= 1.3.2),
-    ggsurvfit (>= 1.0.0),
+    ggsurvfit (>= 1.1.0),
     lme4 (>= 1.1-31),
     parameters (>= 0.20.2),
     smd (>= 0.6.6),
     spelling,
     survey (>= 4.1),
-    survival (>= 3.2-11),
+    survival (>= 3.6-4),
     testthat (>= 3.2.0),
     withr (>= 2.5.0)
 Remotes: 

NAMESPACE

@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+S3method(ard_attributes,survey.design)
 S3method(ard_continuous,survey.design)
 S3method(ard_regression,default)
 S3method(ard_stats_anova,anova)

NEWS.md

@@ -31,6 +31,7 @@ ard_moodtest()          -> ard_stats_mood_test()
   - `ard_smd_smd()` for calculating standardized mean differences using `smd::smd()`. (#4)
   - `ard_survival_survfit()` for survival analyses using `survival::survfit()`. (#43)
   - `ard_continuous.survey.design()` for calculating univariate summary statistics from weighted/survey data using many functions from the {survey} package. (#68)
+  - `ard_attributes.survey.design()` for summarizing labels and attributes from weighted/survey data using many functions from the {survey} package.
   - `ard_survey_svychisq()` for weighted/survey chi-squared test using `survey::svychisq()`. (#72)
   - `ard_survey_svyttest()` for weighted/survey t-tests using `survey::svyttest()`. (#70)
   - `ard_survey_svyranktest()` for weighted/survey rank tests using `survey::svyranktest()`. (#71)

R/ard_attributes.survey.design.R

@@ -0,0 +1,37 @@
+#' ARD Attributes
+#'
+#' @description
+#' Add variable attributes to an ARD data frame.
+#' - The `label` attribute will be added for all columns, and when no label
+#'   is specified and no label has been set for a column using the `label=` argument,
+#'   the column name will be placed in the label statistic.
+#' - The `class` attribute will also be returned for all columns.
+#' - Any other attribute returned by `attributes()` will also be added, e.g. factor levels.
+#'
+#' @rdname ard_attributes
+#' @param data (`survey.design`)\cr
+#'   a design object often created with [`survey::svydesign()`].
+#' @param variables ([`tidy-select`][dplyr::dplyr_tidy_select])\cr
+#'   variables to include
+#' @param label (named `list`)\cr
+#'   named list of variable labels, e.g. `list(cyl = "No. Cylinders")`.
+#'   Default is `NULL`
+#' @inheritParams rlang::args_dots_empty
+#'
+#' @return an ARD data frame of class 'card'
+#' @export
+#'
+#' @examplesIf do.call(asNamespace("cardx")$is_pkg_installed, list(pkg = "survey", reference_pkg = "cardx"))
+#' data(api, package = "survey")
+#' dclus1 <- survey::svydesign(id = ~dnum, weights = ~pw, data = apiclus1, fpc = ~fpc)
+#'
+#' ard_attributes(
+#'   data = dclus1,
+#'   variables = c(sname, dname),
+#'   label = list(sname = "School Name", dname = "District Name")
+#' )
+ard_attributes.survey.design <- function(data, variables = everything(), label = NULL, ...) {
+  set_cli_abort_call()
+
+  cards::ard_attributes(data = data[["variables"]], variables = {{ variables }}, label = label, ...)
+}