surveycore/_pkgdown.yml at main · JDenn0514/surveycore · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
url: https://jdenn0514.github.io/surveycore/

template:
  bootstrap: 5
  bslib:
    font_scale: 1.0
    base_font: {google: "Roboto"}
    code_font: {google: "Inter"}
    heading_font: {google: "Roboto"}
    bg: "#fcfbf9"         # lighten springwood background
    fg: "#000000"         # contrast ratio: 15.76 for text
    primary: "#6666CC"    # periwinkle — links, active states
    navbar-bg: "#CCCCFF"  # periwinkle tint — navbar background
    navbar-light-hover-color: "#6666CC"

home:
  title: "surveycore — Modern Survey Analysis Infrastructure"
  description: >
    S7-based survey design objects with tidy-select interface, automatic
    label preservation, and exact variance estimation.

navbar:
  type: "light"
  bg: "#CCCCFF"  # must match navbar-bg in bslib
  pill-active: "#000000"
  structure:
    left:  [intro, articles, reference, news]
    right: [github]
  components:
    github:
      icon: fab fa-github
      href: https://github.com/JDenn0514/surveycore

articles:
  - title: "Get started"
    contents:
      - getting-started
      - creating-survey-objects
      - surveycore-vs-survey

reference:
  - title: "Survey design constructors"
    desc: >
      Create survey design objects from a data frame. All use a tidy-select
      interface — bare column names, no formula syntax.
    contents:
      - as_survey
      - as_survey_replicate
      - as_survey_twophase
      - as_survey_nonprob
      - update_design

  - title: "Survey collections"
    desc: >
      Group multiple survey designs into a single container for joint
      analysis (e.g., waves of a panel study).
    contents:
      - as_survey_collection
      - add_survey
      - remove_survey
      - set_collection_id
      - set_collection_if_missing_var

  - title: "Estimation"
    desc: >
      Compute weighted estimates with design-correct standard errors.
    contents:
      - meta
      - get_freqs
      - get_means
      - get_totals
      - get_variance
      - get_covariance
      - get_corr
      - get_quantiles
      - get_ratios
      - get_diffs
      - get_t_test
      - get_pairwise
      - get_anova

  - title: "Regression"
    desc: >
      Survey-weighted generalised linear models with Binder (1983)
      sandwich variance estimation.
    contents:
      - survey_glm
      - survey_glm_fit
      - clean

  - title: "Metadata — setters"
    desc: >
      Assign variable labels, value labels, question prefaces, notes, universe
      strings, and missing codes. All setters accept the three-convention API:
      named `...`, a single named vector/list, or `variable` + content argument.
    contents:
      - set_var_label
      - set_val_labels
      - set_question_preface
      - set_var_note
      - set_universe
      - set_missing_codes
      - set_sata
      - infer_question_prefaces

  - title: "Metadata — extractors"
    desc: >
      Retrieve metadata for one or more variables.
    contents:
      - extract_var_label
      - extract_val_labels
      - extract_question_preface
      - extract_var_note
      - extract_universe
      - extract_missing_codes
      - extract_sata
      - extract_metadata
      - classify_question_type
      - survey_weighting_history

  - title: "Conversion"
    desc: >
      Convert between surveycore objects, `survey::svydesign`, and `srvyr::tbl_svy`.
    contents:
      - as_svydesign
      - from_svydesign
      - as_tbl_svy
      - from_tbl_svy

  - title: "S7 class objects"
    desc: >
      S7 classes exported for use in downstream packages and extension code.
      Use `S7::S7_inherits(x, survey_taylor)` for class testing.
    contents:
      - survey_base
      - survey_taylor
      - survey_replicate
      - survey_twophase
      - survey_nonprob
      - survey_metadata
      - survey_collection

  - title: "Utilities"
    desc: Internal helpers exported for use in extension packages.
    contents:
      - survey_data
      - SURVEYCORE_DOMAIN_COL
      - .get_design_vars_flat

  - title: "Example datasets"
    desc: >
      Real-world survey datasets included for testing and illustration.
    contents:
      - nhanes_2017
      - acs_pums_wy
      - anes_2024
      - gss_2024
      - pew_jewish_2020
      - pew_npors_2025
      - ns_wave1