nhanes_search: Search the results from nhanes_variables or nhanes_data_files

View source: R/variables.R

nhanes_searchR Documentation

Search the results from nhanes_variables or nhanes_data_files

Description

Search the results from nhanes_variables or nhanes_data_files

Usage

nhanes_search(
  nhanes_data,
  query,
  ...,
  fuzzy = FALSE,
  ignore_case = TRUE,
  max_distance = 0.2
)

Arguments

nhanes_data

nhanes variable list, from nhanes_variables function, or data file list, from nhanes_data_files

query

regular expression search query

...

additional arguments to pass to dplyr::filter

fuzzy

whether to use fuzzy string matching for search (based on edit distances)

ignore_case

whether search query is case-sensitive

max_distance

parameter for tuning fuzzy string matching, 0-1

Value

data frame filtered by search query

Examples


## Not run: 
nhanes_files <- nhanes_data_files()

# Search for data files about pesticides
nhanes_search(nhanes_files, "pesticides")

## End(Not run)


SilentSpringInstitute/RNHANES documentation built on Feb. 15, 2024, 11:26 p.m.