man-roxygen/formulaiv.R

In kolesarm/ShiftShareSE: Inference in Regressions with Shift-Share Structure

#' @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) of the form \code{outcome ~ controls |
#'     endogenous_regressor}. For a regression with no controls (only an
#'     intercept), it takes the form \code{outcome ~ 1 | endogenous_regressor}
#' @param data An 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. Each row in the data frame
#'     corresponds to a region.
#' @param subset An optional vector specifying a subset of observations to be
#'     used in the fitting process.
#' @param weights An optional vector of weights to be used in the fitting
#'     process. Should be \code{NULL} or a numeric vector, with each row
#'     corresponding to a region. If non-\code{NULL}, for computing the first
#'     stage and the reduced form, weighted least squares is used with weights
#'     \code{weights} (that is, we minimize \code{sum(weights*residuals^2)});
#'     otherwise ordinary least squares is used.