man-roxygen/RDFormula.R

In kolesarm/RDHonest: Honest Inference in Regression Discontinuity Designs

#' @section Note:
#' \code{subset} is evaluated in the same way as variables in \code{formula},
#' that is first in \code{data} and then in the environment of \code{formula}.

#' @param formula an object of class \code{"formula"} (or one that can be
#'     coerced to that class). The formula syntax is \code{outcome ~
#'     running_variable} for inference at a point. For sharp RD, it is
#'     \code{outcome ~ running_variable} if there are no covariates, or
#'     \code{outcome ~ running_variable | covariates} if covariates are present.
#'     For fuzzy RD, it is \code{outcome | treatment ~ running_variable |
#'     covariates}, with \code{covariates} optional.
#' @param data optional data frame, list or environment (or object coercible by
#'     \code{as.data.frame} to a data frame) containing the outcome and running
#'     variables in the model. If not found in \code{data}, the variables are
#'     taken from \code{environment(formula)}, typically the environment from
#'     which the function is called.
#' @param subset optional vector specifying a subset of observations to be used
#'     in the fitting process.
#' @param na.action function which indicates what should happen when the data
#'     contain \code{NA}s. The default is set by the \code{na.action} setting of
#'     \code{options} (usually \code{na.omit}). Another possible value is
#'     \code{na.fail}