lurn_si_29_names: A helper function that returns the recommended variable names...

View source: R/lurn_si_29_names.R

lurn_si_29_namesR Documentation

A helper function that returns the recommended variable names of the LURN SI-29

Description

This function returns a character vector of recommended variable names for the LURN SI-29. The user can 'include' the complete list of 'all' variable names, or only those variable names specific to 'male' or 'female' participants.

Usage

lurn_si_29_names(include = c("all", "female", "male"))

Arguments

include

By default, 'all' variable names of the LURN SI-29 are returned. If desired, the user can request only variable names specific to 'female' respondents or 'male' respondents. If needed, the argument names will be converted to lowercase (i.e., 'ALL', 'All', etc., will be silently converted to 'all').

Value

A character vector of recommended variable names for the LURN SI-29.

Examples

## Not run: 
lurn_si_29_names()

# Only female variable names
lurn_si_29_names(include = "female")

#' Only male variable names
lurn_si_29_names(include = "male")

## End(Not run)

jameswgriffith/lurn documentation built on July 30, 2023, 4:31 a.m.