mariposa (version 0.7.3)

read_sas: Read SAS Data with Tagged Missing Values

Description

Reads a SAS .sas7bdat file and integrates with mariposa's tagged NA system. Handles two scenarios:

1. Native special missing values (.A through .Z, ._): Automatically detected and annotated.

2. Numeric missing codes (e.g., -9, -42): When tag_na is provided, these regular values are converted to tagged NAs, giving the same result as read_spss() with tag_na = TRUE.

Usage

read_sas(
  path,
  catalog_file = NULL,
  encoding = NULL,
  catalog_encoding = NULL,
  tag_na = NULL,
  verbose = FALSE
)

Value

A tibble with the SAS data. Variables with missing value codes have:

• Tagged NAs for each missing type

• An "na_tag_map" attribute mapping tag characters to original codes

• is.na() returns TRUE for these values (standard R behavior)

Arguments

path

Path to a SAS .sas7bdat data file.

catalog_file

Path to a SAS catalog file (.sas7bcat) for value labels. If NULL, no catalog is used.

encoding

Character encoding for the data file. If NULL, haven's default encoding detection is used.

catalog_encoding

Character encoding for the catalog file. If NULL, the same encoding as the data file is used.

tag_na

Numeric vector of values to treat as missing (e.g., c(-9, -8, -42)). These values will be converted to tagged NAs across all numeric variables. Use this when SAS files contain missing codes stored as regular values. Default: NULL (only detect native SAS special missing values).

verbose

If TRUE, prints a message summarizing how many variables contain tagged missing values.

Details

Native Special Missing Values

SAS supports 28 distinct missing value types: . (system missing), .A through .Z, and ._ (underscore). The haven package preserves these as tagged NAs automatically. read_sas() adds the na_tag_map attribute so that mariposa's tagged NA functions work seamlessly.

Numeric Missing Codes (tag_na)

Some SAS files store missing value codes as regular numeric values (e.g., -9 = "No answer"). The tag_na parameter converts these to tagged NAs, enabling proper handling in frequency(), codebook(), and other functions.

When tag_na is used, untag_na() can recover the original numeric codes.

See Also

read_xpt(), na_frequencies(), strip_tags(), untag_na(), read_spss(), read_stata(), haven::read_sas()

Other data-import: na_frequencies(), read_por(), read_spss(), read_stata(), read_xlsx(), read_xpt(), strip_tags(), untag_na()

Examples

# \donttest{
# .sas7bdat files cannot be produced from R, so this only runs when
# one is present in the working directory
if (requireNamespace("haven", quietly = TRUE) &&
    file.exists("survey.sas7bdat")) {
  # Read SAS file with native special missing values
  data <- read_sas("survey.sas7bdat")

  # Read with catalog for value labels
  data <- read_sas("survey.sas7bdat", catalog_file = "formats.sas7bcat")

  # Read SAS file with numeric missing codes
  data <- read_sas("survey.sas7bdat", tag_na = c(-9, -8, -42))
}
# }