bootstrap.estimates: bootstrap.estimates

Description Usage Arguments Value TODO Examples

View source: R/bootstrap_estimates.r

Description

this function contains the core of the rescaled bootstrap method for estimating uncertainty in our estimates it should be designed so that it can be passed in to estimation functions as an argument
OR

Usage

1
2
3
bootstrap.estimates(survey.data, survey.design, bootstrap.fn, estimator.fn,
  num.reps, weights = NULL, ..., summary.fn = NULL, verbose = TRUE,
  parallel = FALSE, paropts = NULL)

Arguments

survey.data

the dataset to use

survey.design

a formula describing the design of the survey (see below - TODO)

bootstrap.fn

name of the method to be used to take bootstrap resamples; see below

estimator.fn

name of a function which, given a dataset like survey data and arguments in ..., will produce an estimate of interest

num.reps

the number of bootstrap replication samples to draw

weights

weights to use in estimation (or NULL, if none)

...

additional arguments which will be passed on to the estimator fn

summary.fn

(optional) name of a function which, given the set of estimates produced by estimator.fn, summarizes them. if not specified, all of the estimates are returned in a list

verbose

if TRUE, produce lots of feedback about what is going on

parallel

if TRUE, use the plyr library's .parallel argument to produce bootstrap resamples and estimates in parallel

paropts

if not NULL, additional arguments to pass along to the parallelization routine

Value

if no summary.fn is specified, then return the list of estimates produced by estimator.fn; if summary.fn is specified, then return its output

TODO

Examples

1
# code goes here

surveybootstrap documentation built on May 29, 2017, 9:09 a.m.