Generate Formatted Text for Measures — boilerplate_generate

This function generates formatted markdown text describing measures in a study. It creates a simple output with customisable heading levels, focusing on presenting measure information in a clean, consistent format.

Usage

boilerplate_generate_measures(
  variable_heading,
  variables,
  db,
  heading_level = 3,
  subheading_level = 4,
  print_waves = FALSE,
  print_keywords = FALSE,
  appendices_measures = NULL,
  label_mappings = NULL,
  quiet = FALSE
)

boilerplate_measures_text(
  variable_heading,
  variables,
  db,
  heading_level = 3,
  subheading_level = 4,
  print_waves = FALSE,
  print_keywords = FALSE,
  appendices_measures = NULL,
  label_mappings = NULL,
  quiet = FALSE
)

boilerplate_generate_measures(
  variable_heading,
  variables,
  db,
  heading_level = 3,
  subheading_level = 4,
  print_waves = FALSE,
  print_keywords = FALSE,
  appendices_measures = NULL,
  label_mappings = NULL,
  quiet = FALSE
)

boilerplate_measures_text(
  variable_heading,
  variables,
  db,
  heading_level = 3,
  subheading_level = 4,
  print_waves = FALSE,
  print_keywords = FALSE,
  appendices_measures = NULL,
  label_mappings = NULL,
  quiet = FALSE
)

Arguments

variable_heading: Character. Heading for the variable section (e.g., "Exposure Variable", "Outcome Variables").
variables: Character vector. Names of the variables to include.
db: List. Measures database. Can be either a measures database or a unified database. If a unified database is provided, the measures category will be extracted.
heading_level: Integer. Heading level for the section header (e.g., 2 for ##, 3 for ###). Default is 3.
subheading_level: Integer. Heading level for individual variables (e.g., 3 for ###, 4 for ####). Default is 4.
print_waves: Logical. Whether to include wave information in the output. Default is FALSE.
print_keywords: Logical. Whether to include keyword information in the output. Default is FALSE.
appendices_measures: Character. Optional reference to appendices containing measure details.
label_mappings: Named character vector. Mappings to transform variable names in the output. For example, c("sdo" = "Social Dominance Orientation", "born_nz_binary" = "Born in NZ"). If a variable name contains any of the keys in this vector, that part will be replaced with the corresponding value.
quiet: Logical. If TRUE, suppresses all CLI alerts. Default is FALSE.

Value

Character string with formatted text describing the measures.

Examples

# Import unified database
unified_db <- boilerplate_import()
#> ℹ importing all categories
#> ℹ using default path: /Users/joseph/GIT/boilerplate/boilerplate/data
#> ! data directory does not exist: /Users/joseph/GIT/boilerplate/boilerplate/data
#> ℹ importing measures database
#> ! measures database file not found, using default
#> ℹ importing methods database
#> ! methods database file not found, using default
#> ℹ importing results database
#> ! results database file not found, using default
#> ℹ importing discussion database
#> ! discussion database file not found, using default
#> ℹ importing appendix database
#> ! appendix database file not found, using default
#> ℹ importing template database
#> ! template database file not found, using default

# Generate exposure variable text with unified database
exposure_text <- boilerplate_generate_measures(
  variable_heading = "Exposure Variable",
  variables = "political_conservative",
  db = unified_db,  # Pass the unified database
  print_waves = TRUE
)
#> ℹ using measures from unified database
#> ℹ generating formatted text for 1 Exposure Variable
#> ℹ using heading level 3 and subheading level 4
#> ℹ processing variable: political_conservative
#> ! no information available for variable: political_conservative
#> ✔ successfully generated formatted text for Exposure Variable

# Import just the measures database
measures_db <- boilerplate_import("measures")
#> ℹ using default path: /Users/joseph/GIT/boilerplate/boilerplate/data
#> ! data directory does not exist: /Users/joseph/GIT/boilerplate/boilerplate/data
#> ℹ importing measures database
#> ! measures database file not found, using default

# Generate outcome variables text with measures database
outcome_text <- boilerplate_generate_measures(
  variable_heading = "Outcome Variables",
  variables = c("anxiety_gad7", "depression_phq9"),
  db = measures_db,  # Pass just the measures database
  appendices_measures = "Appendix A"
)
#> ℹ generating formatted text for 2 Outcome Variables
#> ℹ using heading level 3 and subheading level 4
#> ℹ processing variable: anxiety_gad7
#> ! no information available for variable: anxiety_gad7
#> ℹ processing variable: depression_phq9
#> ! no information available for variable: depression_phq9
#> ℹ adding appendix reference: Appendix A
#> ✔ successfully generated formatted text for Outcome Variables

# Import unified database
unified_db <- boilerplate_import()
#> ℹ importing all categories
#> ℹ using default path: /Users/joseph/GIT/boilerplate/boilerplate/data
#> ! data directory does not exist: /Users/joseph/GIT/boilerplate/boilerplate/data
#> ℹ importing measures database
#> ! measures database file not found, using default
#> ℹ importing methods database
#> ! methods database file not found, using default
#> ℹ importing results database
#> ! results database file not found, using default
#> ℹ importing discussion database
#> ! discussion database file not found, using default
#> ℹ importing appendix database
#> ! appendix database file not found, using default
#> ℹ importing template database
#> ! template database file not found, using default

# Generate exposure variable text with unified database
exposure_text <- boilerplate_generate_measures(
  variable_heading = "Exposure Variable",
  variables = "political_conservative",
  db = unified_db,  # Pass the unified database
  print_waves = TRUE
)
#> ℹ using measures from unified database
#> ℹ generating formatted text for 1 Exposure Variable
#> ℹ using heading level 3 and subheading level 4
#> ℹ processing variable: political_conservative
#> ! no information available for variable: political_conservative
#> ✔ successfully generated formatted text for Exposure Variable

# Import just the measures database
measures_db <- boilerplate_import("measures")
#> ℹ using default path: /Users/joseph/GIT/boilerplate/boilerplate/data
#> ! data directory does not exist: /Users/joseph/GIT/boilerplate/boilerplate/data
#> ℹ importing measures database
#> ! measures database file not found, using default

# Generate outcome variables text with measures database
outcome_text <- boilerplate_generate_measures(
  variable_heading = "Outcome Variables",
  variables = c("anxiety_gad7", "depression_phq9"),
  db = measures_db,  # Pass just the measures database
  appendices_measures = "Appendix A"
)
#> ℹ generating formatted text for 2 Outcome Variables
#> ℹ using heading level 3 and subheading level 4
#> ℹ processing variable: anxiety_gad7
#> ! no information available for variable: anxiety_gad7
#> ℹ processing variable: depression_phq9
#> ! no information available for variable: depression_phq9
#> ℹ adding appendix reference: Appendix A
#> ✔ successfully generated formatted text for Outcome Variables