View source: R/proptestClust.R
proptestClust | R Documentation |
proptestClust
can be used for testing the null that the marginal proportion
(probability of success) is equal to certain given values in clustered data with potentially informative
cluster size.
proptestClust(x, id, p = NULL, alternative = c("two.sided", "less", "greater"), variance = c("sand.null", "sand.est", "emp", "MoM"), conf.level = 0.95)
x |
a vector of binary indicators denoting success/failure of each observation, or a two-dimensional table (or matrix) with 2 columns giving the aggregate counts of failures and successes (respectively) across clusters. |
id |
a vector which identifies the clusters; ignored if |
p |
the null hypothesized value of the marginal proportion. Must be a single number greater than 0 and less than 1. |
alternative |
a character string specifying the alternative hypothesis. Must be one of " |
variance |
character string specifying the method of variance estimation. Must be one of " |
conf.level |
confidence level of the returned confidence interval. Must be a single number between 0 and 1. |
If p
is not given, the null tested is that the underlying marginal probability of
success is .5.
The variance
argument allows the user to specify the method of variance estimation, selecting from
the sandwich estimate evaluated at the null hypothesis (sand.null
), the sandwich estimate evaluated at the
cluster-weighted proportion (sand.est
), the empirical estimate (emp
), or the method of moments
estimate (MoM
).
A list with class "htest
" containing the following components:
statistic |
the value of the test statistic. |
p.value |
the p-value of the test. |
estimate |
the estimated marginal proportion. |
null.value |
the value of |
conf.int |
a confidence interval for the true marginal proportion. |
alternative |
a character string describing the alternative hypothesis. |
method |
a character string indicating the test performed and method of variance estimation. |
data.name |
a character string giving the name of the data and the total number of clusters. |
M |
the number of clusters. |
Gregg, M., Datta, S., Lorenz, D. (2020) Variance Estimation in Tests of Clustered Categorical Data with Informative Cluster Size. Statistical Methods in Medical Research, doi:10.1177/0962280220928572.
data(screen8) ## using vectors ## suppose math proficiency is determined by score >= 65 ## is the marginal proportion of students proficient in math at least 75%? screen8$math.p <- 1*(screen8$math>=65) proptestClust(screen8$math.p, screen8$sch.id, p = .75, alternative = "great") ## using table and empirical variance; two-sided CI ## (note that "failure" counts are the first column and "success" counts are the second column) mathp.tab <- table(screen8$sch.id, screen8$math.p) proptestClust(mathp.tab, variance="emp", p=.75) ## when all clusters have a size of 1, results will be in general correspondence with ## that of the classical analogue test set.seed(123) x <- rbinom(100, size = 1, p = 0.7) id <- 1:100 proptestClust(x, id) prop.test(sum(x), length(x))
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.