Skip to content

Commit

Permalink
doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
mattblackwell committed Nov 7, 2024
1 parent 2544c5d commit e6f993c
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 8 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Package: Amelia
Version: 1.8.2
Version: 1.8.2.9000
Date: 2024-04-10
Title: A Program for Missing Data
Authors@R: c(
Expand Down
1 change: 0 additions & 1 deletion R/summary.mi.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
#' @param ... further arguments.
#'
#' @seealso \code{\link{amelia}}
#' @exportS3method

summary.mi <- function(object, ...) {
m <- length(object)
Expand Down
2 changes: 1 addition & 1 deletion R/write.amelia.R
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
#' then the original, unimputed dataset is included at the top of the
#' stack, with its imputation number set to 0.
#'
#' @seealso \code{\link{write.csv}}, \code{\link{write.table}}, \code{\link{foreign::write.dta}}
#' @seealso \code{\link{write.csv}}, \code{\link{write.table}}, \code{\link[foreign]{write.dta}}

write.amelia <- function(obj, separate = TRUE, file.stem,
extension = NULL, format = "csv",
Expand Down
21 changes: 21 additions & 0 deletions man/summary.mi.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/write.amelia.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 1 addition & 3 deletions vignettes/intro-mi.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,7 @@ The Amelia program goes several significant steps beyond the capabilities of the

## What Amelia Does {#sec:what}

Multiple imputation involves imputing $m$ values for each missing cell in your data matrix and creating $m$ "completed" data sets. Across these completed data sets, the observed values are the same, but the missing values are filled in with a distribution of imputations that reflect the uncertainty about the missing data. After imputation with Amelia's EMB algorithm, you can apply whatever statistical method you would have used if there had been no missing values to each of the $m$ data sets, and use a simple procedure, described below, to combine the results[^combine]. Under normal circumstances, you only need to impute once and can then analyze the $m$ imputed data sets as many times and for as many purposes as you wish. The advantage of Amelia is that it combines the comparative speed and ease-of-use of our algorithm with the power of multiple imputation, to let you focus on your substantive research questions rather than spending time developing complex application-specific models for nonresponse in each new data set. Unless the rate of missingness is very high, $m = 5$ (the program default) is probably adequate.

[^combine]: You can combine the results automatically by doing your data analyses within [Zelig for R](https://docs.zeligproject.org/index.html), or within [Clarify for Stata](https://gking.harvard.edu/clarify).
Multiple imputation involves imputing $m$ values for each missing cell in your data matrix and creating $m$ "completed" data sets. Across these completed data sets, the observed values are the same, but the missing values are filled in with a distribution of imputations that reflect the uncertainty about the missing data. After imputation with Amelia's EMB algorithm, you can apply whatever statistical method you would have used if there had been no missing values to each of the $m$ data sets, and use a simple procedure, described below, to combine the results. Under normal circumstances, you only need to impute once and can then analyze the $m$ imputed data sets as many times and for as many purposes as you wish. The advantage of Amelia is that it combines the comparative speed and ease-of-use of our algorithm with the power of multiple imputation, to let you focus on your substantive research questions rather than spending time developing complex application-specific models for nonresponse in each new data set. Unless the rate of missingness is very high, $m = 5$ (the program default) is probably adequate.

### Assumptions

Expand Down
2 changes: 1 addition & 1 deletion vignettes/using-amelia.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,7 @@ out <- mi.combine(imp.models, conf.int = TRUE)
out
```

The combination of the results depends on the [broom](https://broom.tidymodels.org) package and results can be combined if a `tidy()` method exists for the estimation function passed to `with()`. Other packages such as [Zelig](https://docs.zeligproject.org/index.html) can also combine imputed data sets across a number of statistical models. Furthermore, users can easily export their imputations using the `write.amelia()` function as described in \@ref(sec_saving) and use statistical packages other than R for the analysis model.
The combination of the results depends on the [broom](https://broom.tidymodels.org) package and results can be combined if a `tidy()` method exists for the estimation function passed to `with()`. Users can easily export their imputations using the `write.amelia()` function as described in \@ref(sec_saving) and use statistical packages other than R for the analysis model.

In addition to the resources available in R, users can draw on
Stata to implement their analysis models. As of version 11,
Expand Down

0 comments on commit e6f993c

Please sign in to comment.