diff --git a/man/Impute.purse.Rd b/man/Impute.purse.Rd index 0e33dd5..40f533d 100644 --- a/man/Impute.purse.Rd +++ b/man/Impute.purse.Rd @@ -56,15 +56,19 @@ after imputation has been applied. Set \code{FALSE} to suppress these warnings.} An updated purse with imputed data sets added to each coin. } \description{ -This function imputes the target data set \code{dset} in each coin using the imputation function \code{f_i}. This is performed -in the same way as the coin method \code{\link[=Impute.coin]{Impute.coin()}}, but with one "special case" for panel data. If \verb{f_i = "impute_panel}, -the data sets inside the purse are imputed using the \code{\link[=impute_panel]{impute_panel()}} -function. In this case, coins are not imputed individually, but treated as a single data set. In this -case, optionally set the imputation method as \code{f_i_para = list(imp_type = .)} -and \code{f_i_para = list(max_time = .)} where \code{.} should be substituted with the maximum -number of time points to search backwards for a non-\code{NA} value. See \code{\link[=impute_panel]{impute_panel()}} for more details. -No further arguments need to be passed to \code{\link[=impute_panel]{impute_panel()}}. See \code{vignette("imputation")} for more -details. See also \code{\link[=Impute.coin]{Impute.coin()}} documentation. +This function imputes the target data set \code{dset} in each coin using the imputation function \code{f_i}, and optionally by specifying +parameters via \code{f_i_para}. This is performed in the same way as the coin method \code{\link[=Impute.coin]{Impute.coin()}}, i.e. each time point is imputed separately, +\emph{unless} \code{f_i = "impute_panel"}. See details for more information. +} +\details{ +If \code{f_i = "impute_panel"} this is treated as a special case, and the data sets inside the purse are imputed using the \code{\link[=impute_panel]{impute_panel()}} +function, which allows imputation of time series, using past/future values as information for imputation. + +In this case, coins are not imputed individually, but treated as a single data set. To do this, set \code{f_i = "impute_panel"} +and pass further parameters to \code{\link[=impute_panel]{impute_panel()}} using the \code{f_i_para} argument. Note that as this is a special case, +the supported parameters of \code{\link[=impute_panel]{impute_panel()}} to specify through \code{\link[=Impute]{Impute()}} are \code{"imp_type"} and \code{"max_time"} (see \code{\link[=Impute]{Impute()}} +for details on these). No further arguments need to be passed to \code{\link[=impute_panel]{impute_panel()}}. See \code{vignette("imputation")} for more +details. } \examples{ # see vignette("imputation")