datareq_params: Data Request Parameters

In serotracker/serosurvr: SeroTracker Serosurvey Data Analysis Tools

Data Request Parameters

Description

Creates an object specifying parameters for a request for SeroTracker data.

Usage

datareq_params(
  reqname = character(),
  research_fields = TRUE,
  prioritize_estimates = FALSE,
  estimates_subgroup = "all_estimates",
  prioritize_estimates_mode = "analysis_dynamic",
  columns = NULL,
  sampling_start_date = NULL,
  sampling_end_date = NULL,
  publication_start_date = NULL,
  publication_end_date = NULL,
  include_in_srma = NULL,
  include_records_without_latlngs = TRUE,
  include_disputed_regions = TRUE,
  calculate_country_seroprev_summaries = FALSE,
  filters = list()
)

Arguments

reqname	Request name. Used as an identifier and for caching.
research_fields	Should research fields be pulled? Defaults to TRUE
prioritize_estimates	If TRUE and estimates_subgroup not specified, will set estimates_subgroup to 'prioritize_estimates'. Defaults to FALSE.
estimates_subgroup	Should one primary estimate per study be returned ('primary_estimates'), one priority estimate per study ('prioritize_estimates'), or all estimates ('all_estimates')? Defaults to 'all_estimates'.
prioritize_estimates_mode	What mode should be used to prioritize estimates? Defaults to 'analysis_dynamic'; other options are 'analysis_static' and 'dashboard'
columns	List or empty; if not empty, returns only the specified columns
sampling_start_date	Filter results by sampling_start_date; format: YYYY-MM-DD
sampling_end_date	Filter results by sampling_end_date; format: YYYY-MM-DD
publication_start_date	Filter results by publication_start_date; format: YYYY-MM-DD
publication_end_date	Filter results by publication_end_date; format: YYYY-MM-DD
include_in_srma	Whether to filter results by a custom variable in AirTable; not recommended to use this unless you have confirmed that the AirTable flag you are using is properly configured to work with this variable
include_records_without_latlngs	Whether to include records without latitude and longitude coordinates. Defaults to TRUE
include_disputed_regions	Whether to include disputed regions. Defaults to TRUE
calculate_country_seroprev_summaries	Defaults to FALSE to return only records
filters	Named list, with filter names and a list of allowed options for that filter

See Also

get_data which takes these params as input

Examples

fs_males_params <- datareq_params(reqname = "france_spain_males",
                                  research_fields = TRUE,
                                  estimates_subgroup = 'prioritize_estimates',
                                  filters = list(country = list("France", "Spain"),
                                                 sex = list("Male")))

serotracker/serosurvr documentation built on July 1, 2022, 7:49 p.m.