% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/core-metadata.R
\name{extract_sata}
\alias{extract_sata}
\title{Extract SATA (Select-All-That-Apply) Flags}
\usage{
extract_sata(x, ..., format = "named_vector", fill = FALSE)
}
\arguments{
\item{x}{A survey design object or \code{data.frame}.}

\item{...}{<\code{\link[tidyselect:language]{tidy-select}}> Variables to query.
Supports selection helpers: \code{\link[tidyselect:starts_with]{tidyselect::starts_with()}},
\code{\link[tidyselect:all_of]{tidyselect::all_of()}}, \code{\link[tidyselect:all_of]{tidyselect::any_of()}}, etc. If empty, returns
SATA status for all columns of \code{x}.}

\item{format}{\code{character(1)}. Output format: \code{"named_vector"} (default),
\code{"list"}, or \code{"data_frame"}.}

\item{fill}{\code{FALSE} (default) or \code{NULL}. Controls how unmarked variables
are reported. \code{FALSE} includes them in the result with value \code{FALSE}
(dense view); \code{NULL} omits them (sparse view). \code{TRUE} and other values
are rejected.}
}
\value{
\itemize{
\item \code{"named_vector"} (default): named logical vector. Empty: \code{logical(0)}.
\item \code{"list"}: named list of logical scalars. Empty: \code{list()}.
\item \code{"data_frame"}: tibble with columns \code{variable} (character) and \code{sata}
(logical). Empty: zero-row tibble.
}
}
\description{
Returns the SATA status for one or more variables in a survey design object
or a data frame.
}
\examples{
d <- as_survey(nhanes_2017, ids = sdmvpsu, weights = wtint2yr,
               strata = sdmvstra, nest = TRUE)
d <- set_sata(d, riagendr)
extract_sata(d, riagendr)
extract_sata(d, fill = NULL)

}
\seealso{
\code{\link[=set_sata]{set_sata()}} to set SATA flags

Other metadata: 
\code{\link{classify_question_type}()},
\code{\link{extract_metadata}()},
\code{\link{extract_missing_codes}()},
\code{\link{extract_question_preface}()},
\code{\link{extract_universe}()},
\code{\link{extract_val_labels}()},
\code{\link{extract_var_label}()},
\code{\link{extract_var_note}()},
\code{\link{infer_question_prefaces}()},
\code{\link{set_missing_codes}()},
\code{\link{set_question_preface}()},
\code{\link{set_sata}()},
\code{\link{set_universe}()},
\code{\link{set_val_labels}()},
\code{\link{set_var_label}()},
\code{\link{set_var_note}()},
\code{\link{survey_metadata}()},
\code{\link{survey_weighting_history}()}
}
\concept{metadata}
