average_stat: average_stat
In edwinfarley/GFS: Permutation Sampler
Description
Usage
Arguments
Details
Description
Use permutations to estimate the statistic stat using multiple imputation
over the full data set. Return the estimate, total variance (between and
within imputation variance), and confidence interval at the 'a' level.
Usage
1
average_stat(df1, df2, P, stat, stat_var = NULL, a = 0.95, block = "block")
Arguments
df1
The R data frame of the first data set.
df2
The R data frame of the second data set. This is the data set
to which the permutations in P will be applied.
P
Matrix of permutations where each column is a complete permutation
with respect to df2. The number of columns is the number of
imputations.
stat
The statistic to be computed. A function that accepts a data frame
and returns a number.
stat_var
An optional argument that is a function to compute the variance
of the statistic defined by stat. If no function is specified, then the
value for variance that will be returned is the sample variance of the
estimates for stat (the between imputation variance). If a function is
specified, then the value for variance that is returned is the total
variance computed according to Rubin's rules for multiple imputation,
where stat_var is the within imputation variance.
a
Confidence level for the confidence interval.
block
Name of the block column. The block column is removed.
Details
This file is part of GFS.
GFS is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
GFS is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with GFS. If not, see <https://www.gnu.org/licenses/>.
edwinfarley/GFS documentation built on Dec. 5, 2020, 1:43 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Details
Description
Use permutations to estimate the statistic stat using multiple imputation over the full data set. Return the estimate, total variance (between and within imputation variance), and confidence interval at the 'a' level.
Usage
1 | average_stat(df1, df2, P, stat, stat_var = NULL, a = 0.95, block = "block")
|
Arguments
df1 |
The R data frame of the first data set. |
df2 |
The R data frame of the second data set. This is the data set to which the permutations in P will be applied. |
P |
Matrix of permutations where each column is a complete permutation with respect to df2. The number of columns is the number of imputations. |
stat |
The statistic to be computed. A function that accepts a data frame and returns a number. |
stat_var |
An optional argument that is a function to compute the variance of the statistic defined by stat. If no function is specified, then the value for variance that will be returned is the sample variance of the estimates for stat (the between imputation variance). If a function is specified, then the value for variance that is returned is the total variance computed according to Rubin's rules for multiple imputation, where stat_var is the within imputation variance. |
a |
Confidence level for the confidence interval. |
block |
Name of the block column. The block column is removed. |
Details
This file is part of GFS.
GFS is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
GFS is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with GFS. If not, see <https://www.gnu.org/licenses/>.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.