% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/acsmoe-package.R
\docType{package}
\name{acsmoe-package}
\alias{acsmoe}
\alias{acsmoe-package}
\title{acsmoe: Propagate Uncertainty for ACS Tabular Estimates}
\description{
\code{acsmoe} provides utilities for American Community Survey workflows that
already have published estimates and margins of error. It complements
\code{tidycensus} by matching the standard zero-covariance ACS MOE formulas by
default while allowing users to supply covariance structures when available.
}
\details{
The package does not download ACS data, estimate variance from microdata, or
implement regionalization. Use \code{tidycensus} for data access and \code{survey} or
\code{srvyr} for microdata/replicate-weight workflows.

Core references include the U.S. Census Bureau ACS handbook guidance on
derived estimates, Walker and Herman's \code{tidycensus} package, and the ACS
uncertainty literature by Spielman, Folch, Nagle, Arribas-Bel, and
Koschinsky. See the README and vignettes for full references.
}
\section{Output shape}{

Propagation helpers (\code{acs_sum}, \code{acs_diff}, \code{acs_ratio}, \code{acs_prop},
\code{acs_product}, \code{acs_linear}) return a data frame with columns \code{estimate},
\code{moe}, and \code{se}. \code{moe_ci()} returns \code{estimate}, \code{lower}, \code{upper}, \code{moe}.
\code{acs_simulate()} returns a numeric matrix of draws. \code{acs_simulate_fn()}
returns either \verb{(estimate, se)} for \code{summary = "mean"}/\code{"median"}, or
\verb{(estimate, lower, upper)} for \code{summary = "ci"}. \code{acs_cv()} and
\code{acs_reliability()} return atomic vectors.
}

\seealso{
Useful links:
\itemize{
  \item \url{https://dshkol.github.io/acsmoe/}
  \item \url{https://github.com/dshkol/acsmoe}
  \item Report bugs at \url{https://github.com/dshkol/acsmoe/issues}
}

}
\author{
\strong{Maintainer}: Dmitry Shkolnik \email{dmitry@dshkol.com}

}
\keyword{internal}
