% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/magentabook-package.R
\docType{package}
\name{magentabook-package}
\alias{magentabook}
\alias{magentabook-package}
\title{magentabook: HM Treasury Magenta Book Policy Evaluation Primitives}
\description{
Implements the framework set out in HM Treasury's Magenta Book
(2020): theory of change, evaluation planning, power analysis,
Maryland SMS ratings, structured confidence ratings, light-weight
difference-in-differences and interrupted-time-series estimators,
and cost-effectiveness analysis. Designed as the evaluation
companion to the appraisal package \code{greenbook}.
}
\section{Function families}{

\itemize{
\item \strong{Theory of change}: \code{\link[=mb_theory_of_change]{mb_theory_of_change()}}, \code{\link[=mb_logframe]{mb_logframe()}},
\code{\link[=mb_assumptions]{mb_assumptions()}}.
\item \strong{Planning}: \code{\link[=mb_evaluation_plan]{mb_evaluation_plan()}}, \code{\link[=mb_questions]{mb_questions()}},
\code{\link[=mb_counterfactual]{mb_counterfactual()}}, \code{\link[=mb_stakeholders]{mb_stakeholders()}}.
\item \strong{Power and design}: \code{\link[=mb_power]{mb_power()}}, \code{\link[=mb_mde]{mb_mde()}},
\code{\link[=mb_sample_size]{mb_sample_size()}}, \code{\link[=mb_cluster_design]{mb_cluster_design()}},
\code{\link[=mb_stepped_wedge]{mb_stepped_wedge()}}, \code{\link[=mb_icc_reference]{mb_icc_reference()}}.
\item \strong{Maryland SMS}: \code{\link[=mb_sms_rate]{mb_sms_rate()}}, \code{\link[=mb_sms_explain]{mb_sms_explain()}}.
\item \strong{Confidence}: \code{\link[=mb_confidence]{mb_confidence()}}, \code{\link[=mb_confidence_summary]{mb_confidence_summary()}}.
\item \strong{Estimators}: \code{\link[=mb_did_2x2]{mb_did_2x2()}}, \code{\link[=mb_its]{mb_its()}}, \code{\link[=mb_event_study]{mb_event_study()}}.
\item \strong{Cost-effectiveness}: \code{\link[=mb_cea]{mb_cea()}}, \code{\link[=mb_icer]{mb_icer()}}, \code{\link[=mb_ceac]{mb_ceac()}},
\code{\link[=mb_inb]{mb_inb()}}, \code{\link[=mb_qaly]{mb_qaly()}}, \code{\link[=mb_daly]{mb_daly()}}.
\item \strong{Realist}: \code{\link[=mb_cmo]{mb_cmo()}}, \code{\link[=mb_contribution_claim]{mb_contribution_claim()}}.
\item \strong{Reporting}: \code{\link[=mb_evaluation_report]{mb_evaluation_report()}}, \code{\link[=mb_to_word]{mb_to_word()}},
\code{\link[=mb_to_excel]{mb_to_excel()}}, \code{\link[=mb_to_latex]{mb_to_latex()}}.
\item \strong{Lookups}: \code{\link[=mb_data_versions]{mb_data_versions()}}, \code{\link[=mb_schedule_table]{mb_schedule_table()}}.
}
}

\section{Reproducibility}{

Bundled rubric and reference tables in \verb{inst/extdata/} carry
vintage metadata accessible via \code{\link[=mb_data_versions]{mb_data_versions()}}. Every result
object records the package version it was produced under.
}

\references{
HM Treasury (2020). The Magenta Book: Central Government Guidance
on Evaluation. London: HMSO.
}
\seealso{
Useful links:
\itemize{
  \item \url{https://github.com/charlescoverdale/magentabook}
  \item Report bugs at \url{https://github.com/charlescoverdale/magentabook/issues}
}

}
\author{
\strong{Maintainer}: Charles Coverdale \email{charlesfcoverdale@gmail.com}

}
\keyword{internal}
