diff --git a/R/aggr_es.R b/R/aggr_es.R index 6060248..0e41cc4 100644 --- a/R/aggr_es.R +++ b/R/aggr_es.R @@ -1,5 +1,6 @@ #' @title Aggregates event-study treatment effects. #' +#' @md #' @description Aggregates post- (and/or pre-) treatment effects of an #' "event-study" estimation, also known as a dynamic difference-in-differences #' (DDiD) model. The event-study should have been estimated using the `fixest` diff --git a/R/iplot_data.R b/R/iplot_data.R index a04d28a..02e806a 100644 --- a/R/iplot_data.R +++ b/R/iplot_data.R @@ -1,5 +1,6 @@ #' @title Internal function for grabbing and preparing iplot data #' +#' @md #' @description Grabs the underlying data used to construct `fixest::iplot`, #' with some added functionality and tweaks for the `ggiplot` equivalents. #' @param object A model object of class `fixest` or `fixest_multi`, where @@ -17,10 +18,10 @@ #' the coefficients to be grouped while the name of the element is the group #' name. Passed down to `fixest::coefplot(..., group = .group)`. Example of #' valid uses: -#' ⁠group=list(group_name=\"pattern\")⁠, -#' ⁠group=list(group_name=c(\"var_start\", \"var_end\"))⁠, -#' ⁠group=list(group_name=1:2)) -#' See the Details section of `?fixest::coefplot` for more. +#' * group=list(group_name="pattern") +#' * group=list(group_name=c("var_start", "var_end")) +#' * group=list(group_name=1:2) +#' * See the Details section of `?fixest::coefplot` for more. #' @param .dict A dictionary (i.e. named character vector or a logical scalar). #' Used for changing coefficient names. Defaults to the values in #' `getFixest_dict()`. See the `?fixest::coefplot` documentation for more diff --git a/man/iplot_data.Rd b/man/iplot_data.Rd index 3e2a6e4..74f67db 100644 --- a/man/iplot_data.Rd +++ b/man/iplot_data.Rd @@ -80,10 +80,12 @@ added as a column to the returned data frame. Passed to the coefficients to be grouped while the name of the element is the group name. Passed down to \code{fixest::coefplot(..., group = .group)}. Example of valid uses: -⁠group=list(group_name=\"pattern\")⁠, -⁠group=list(group_name=c(\"var_start\", \"var_end\"))⁠, -⁠group=list(group_name=1:2)) -See the Details section of \code{?fixest::coefplot} for more.} +\itemize{ +\item group=list(group_name="pattern") +\item group=list(group_name=c("var_start", "var_end")) +\item group=list(group_name=1:2) +\item See the Details section of \code{?fixest::coefplot} for more. +}} \item{.vcov, .cluster, .se}{Alternative options for adjusting the standard errors of the model object on the fly. See \code{summary.fixest} for details