From f2441c84c739bd14b59ff50dccdc4bf1c588e6c2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 22 May 2024 21:08:20 +0000 Subject: [PATCH] Update pkgdown documentation 3973772b377ede8ae51912f2c888b2071bb5285b --- main/404.html | 10 +- main/CODE_OF_CONDUCT.html | 10 +- main/CONTRIBUTING.html | 10 +- main/LICENSE-text.html | 10 +- main/PULL_REQUEST_TEMPLATE.html | 10 +- main/SECURITY.html | 10 +- main/authors.html | 14 +- main/index.html | 10 +- main/news/index.html | 20 +-- main/pkgdown.yml | 4 +- main/reference/ard_aod_wald_test.html | 26 +-- main/reference/ard_attributes.html | 137 ++++++++++++++ main/reference/ard_car_anova.html | 40 ++--- main/reference/ard_car_vif.html | 26 +-- ...html => ard_continuous.survey.design.html} | 50 +++--- main/reference/ard_effectsize_cohens_d.html | 64 +++---- main/reference/ard_effectsize_hedges_g.html | 64 +++---- .../ard_emmeans_mean_difference.html | 52 +++--- main/reference/ard_proportion_ci.html | 75 +++----- main/reference/ard_regression.html | 49 ++--- main/reference/ard_regression_basic.html | 38 ++-- main/reference/ard_smd_smd.html | 42 ++--- main/reference/ard_stats_anova.html | 136 +++++--------- main/reference/ard_stats_aov.html | 24 +-- main/reference/ard_stats_chisq_test.html | 34 ++-- main/reference/ard_stats_fisher_test.html | 51 ++---- main/reference/ard_stats_kruskal_test.html | 22 +-- main/reference/ard_stats_mcnemar_test.html | 38 ++-- main/reference/ard_stats_mood_test.html | 27 +-- main/reference/ard_stats_oneway_test.html | 26 +-- main/reference/ard_stats_prop_test.html | 54 ++---- main/reference/ard_stats_t_test.html | 90 +++------- main/reference/ard_stats_wilcox_test.html | 92 +++------- main/reference/ard_survey_svychisq.html | 30 +--- main/reference/ard_survey_svyranktest.html | 102 ++++------- main/reference/ard_survey_svyttest.html | 42 ++--- main/reference/ard_survival_survdiff.html | 22 +-- main/reference/ard_survival_survfit.html | 167 ++++++------------ main/reference/cardx-package.html | 10 +- main/reference/construction_helpers.html | 26 +-- main/reference/dot-extract_wald_results.html | 10 +- .../dot-format_cohens_d_results.html | 30 ++-- .../dot-format_hedges_g_results.html | 30 ++-- .../dot-format_mcnemartest_results.html | 24 +-- .../dot-format_moodtest_results.html | 22 +-- .../dot-format_proptest_results.html | 10 +- .../reference/dot-format_survfit_results.html | 60 +++---- main/reference/dot-format_ttest_results.html | 42 ++--- .../dot-format_wilcoxtest_results.html | 38 ++-- .../dot-paired_data_pivot_wider.html | 14 +- main/reference/dot-process_survfit_probs.html | 12 +- main/reference/dot-process_survfit_time.html | 12 +- .../reference/dot-strata_normal_quantile.html | 10 +- .../dot-update_weights_strat_wilson.html | 10 +- main/reference/index.html | 23 ++- main/reference/proportion_ci.html | 10 +- main/reference/reexports.html | 24 +-- main/search.json | 2 +- main/sitemap.xml | 9 +- 59 files changed, 807 insertions(+), 1349 deletions(-) create mode 100644 main/reference/ard_attributes.html rename main/reference/{ard_survey_svycontinuous.html => ard_continuous.survey.design.html} (62%) diff --git a/main/404.html b/main/404.html index d0f4f5d79..a38ab7139 100644 --- a/main/404.html +++ b/main/404.html @@ -32,7 +32,7 @@ cardx - 0.1.0.9041 + 0.1.0.9042
part of NESTpharmaverse
+ + + + + +
+
+
+

ARD Attributes

+ Source: R/ard_attributes.survey.design.R +
ard_attributes.Rd
+
+ +
+

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.

    • +
+ +
+

Usage

+ 
# S3 method for survey.design
+ard_attributes(data, variables = everything(), label = NULL, ...)
+
+ +
+

Arguments

+
data
+

(survey.design)
+a design object often created with survey::svydesign().

+ + +
variables
+

(tidy-select)
+variables to include

+ + +
label
+

(named list)
+named list of variable labels, e.g. list(cyl = "No. Cylinders"). +Default is NULL

+ + +
...
+

These dots are for future extensions and must be empty.

+ +
+
+

Value

+ + +

an ARD data frame of class 'card'

+
+ +
+

Examples

+ 
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")
+)
+#> {cards} data frame: 4 x 5
+#>   variable   context stat_name stat_label      stat
+#> 1    sname attribut…     label  Variable… School N…
+#> 2    sname attribut…     class  Variable… character
+#> 3    dname attribut…     label  Variable… District…
+#> 4    dname attribut…     class  Variable… character
+
+
+
+ + +
+ + + + + + + diff --git a/main/reference/ard_car_anova.html b/main/reference/ard_car_anova.html index 081769814..45bac38ce 100644 --- a/main/reference/ard_car_anova.html +++ b/main/reference/ard_car_anova.html @@ -10,7 +10,7 @@ cardx - 0.1.0.9041 + 0.1.0.9042
part of NESTpharmaverse