nhanes_pa_quantile: Evaluate a single NHANES physical activity quantile

View source: R/map-quantiles.R

nhanes_pa_quantileR Documentation

Evaluate a single NHANES physical activity quantile

Description

Evaluate a single NHANES physical activity quantile

Usage

nhanes_pa_quantile(
  value,
  age = NULL,
  sex = NULL,
  measure,
  wave = NULL,
  age_category = NULL
)

Arguments

value

Observed physical activity value.

age

Age in years. Set to NULL to use the age-overall CDFs. Ignored when age_category is supplied.

sex

Sex/gender. Common values such as "M", "male", "F", and "female" are normalized. Set to NULL to use the sex/gender-overall CDFs.

measure

Physical activity measure. Supported aliases include "mims", "PAXMTSM", "ssl_steps", "scsslsteps", "steps", Verisense step aliases such as "steps_stepcount_ssl", "steps_stepcount_rf", "steps_vs_original", "steps_vs_revised", "steps_sdt", and "AC".

wave

Optional NHANES wave. Supported values are 7, 8, "2011-2012", and "2013-2014".

age_category

Optional NHANES age category such as "[20,30)" or "Overall".

Value

A numeric quantile in ⁠[0, 1]⁠, or NA_real_ when no matching CDF is available.

Examples

nhanes_pa_quantile(
  value = 15000,
  age = 25,
  sex = "Female",
  measure = "mims"
)

nhanes_pa_quantile(
  value = 15000,
  age = 25,
  sex = NULL,
  measure = "mims",
  wave = "2013-2014"
)

mapnhanespa documentation built on June 2, 2026, 5:07 p.m.