Debian Codegraph @

R/data-documentation.R

raw
1 #' Achievement Awards Demonstration program
2 #'
3 #' Data from a randomized trial of the Achievement Awards
4 #' Demonstration program, reported in Angrist & Lavy (2009).
5 #'
6 #' @format A data frame with 16526 rows and 21 variables: \describe{
7 #' \item{school_id}{Fictitious school identification number}
8 #' \item{school_type}{Factor identifying the school type (Arab religious, Jewish religious, Jewish secular)}
9 #' \item{pair}{Number of treatment pair. Note that 7 is a triple.}
10 #' \item{treated}{Indicator for whether school was in treatment group}
11 #' \item{year}{Cohort year}
12 #' \item{student_id}{Fictitious student identification number}
13 #' \item{sex}{Factor identifying student sex}
14 #' \item{siblings}{Number of siblings}
15 #' \item{immigrant}{Indicator for immigrant status}
16 #' \item{father_ed}{Father's level of education}
17 #' \item{mother_ed}{Mother's level of education}
18 #' \item{Bagrut_status}{Indicator for Bagrut attainment}
19 #' \item{attempted}{Number of Bagrut units attempted}
20 #' \item{awarded}{Number of Bagrut units awarded}
21 #' \item{achv_math}{Indicator for satisfaction of math requirement}
22 #' \item{achv_english}{Indicator for satisfaction of English requirement}
23 #' \item{achv_hebrew}{Indicator for satisfaction of Hebrew requirement}
24 #' \item{lagscore}{Lagged Bagrut score}
25 #' \item{qrtl}{Quartile within distribution of lagscore, calculated by cohort and sex}
26 #' \item{half}{Lower or upper half within distribution of lagscore, calculated by cohort and sex}
27 #' }
28 #'
29 #' @source \href{https://economics.mit.edu/people/faculty/josh-angrist/angrist-data-archive}{Angrist Data Archive}
30 #'
31 #' @references Angrist, J. D., & Lavy, V. (2009). The effects of high stakes
32 #' high school achievement awards : Evidence from a randomized trial.
33 #' \emph{American Economic Review, 99}(4), 1384-1414.
34 #' \doi{10.1257/aer.99.4.1384}
35 #'
36
37 "AchievementAwardsRCT"
38
39
40
41 #' Dropout prevention/intervention program effects
42 #'
43 #' A dataset containing estimated effect sizes, variances, and covariates from a
44 #' meta-analysis of dropout prevention/intervention program effects, conducted
45 #' by Wilson et al. (2011). Missing observations were imputed.
46 #'
47 #' @format A data frame with 385 rows and 18 variables: \describe{
48 #' \item{LOR1}{log-odds ratio measuring the intervention effect}
49 #' \item{varLOR}{estimated sampling variance of the log-odds ratio}
50 #' \item{studyID}{unique identifier for each study} \item{studySample}{unique
51 #' identifier for each sample within a study} \item{study_design}{study design
52 #' (randomized, matched, or non-randomized and unmatched)}
53 #' \item{outcome}{outcome measure for the intervention effect is estimated
54 #' (school dropout, school enrollment, graduation, graduation or GED receipt)}
55 #' \item{evaluator_independence}{degree of evaluator independence
56 #' (independent, indirect but influential, involved in planning but not
57 #' delivery, involved in delivery)} \item{implementation_quality}{level of
58 #' implementation quality (clear problems, possible problems, no apparent
59 #' problems)} \item{program_site}{Program delivery site (community, mixed,
60 #' school classroom, school but outside of classroom)}
61 #' \item{attrition}{Overall attrition (proportion)}
62 #' \item{group_equivalence}{pretest group-equivalence log-odds ratio}
63 #' \item{adjusted}{adjusted or unadjusted data used to calculate intervention
64 #' effect} \item{male_pct}{proportion of the sample that is male}
65 #' \item{white_pct}{proportion of the sample that is white}
66 #' \item{average_age}{average age of the sample} \item{duration}{program
67 #' duration (in weeks)} \item{service_hrs}{program contact hours per week}
68 #' \item{big_study}{indicator for the 32 studies with 3 or more effect sizes}
69 #' }
70 #'
71 #' @source Wilson, S. J., Lipsey, M. W., Tanner-Smith, E., Huang, C. H., &
72 #' Steinka-Fry, K. T. (2011). Dropout prevention and intervention programs:
73 #' Effects on school completion and dropout Among school-aged children and
74 #' youth: A systematic review. _Campbell Systematic Reviews, 7_(1), 1-61.
75 #' \doi{10.4073/csr.2011.8}
76 #'
77 #' @references Wilson, S. J., Lipsey, M. W., Tanner-Smith, E., Huang, C. H., &
78 #' Steinka-Fry, K. T. (2011). Dropout prevention and intervention programs:
79 #' Effects on school completion and dropout Among school-aged children and
80 #' youth: A systematic review. _Campbell Systematic Reviews, 7_(1), 1-61.
81 #' \doi{10.4073/csr.2011.8}
82 #'
83 #' Tipton, E., & Pustejovsky, J. E. (2015). Small-sample adjustments for tests
84 #' of moderators and model fit using robust variance estimation in
85 #' meta-regression. _Journal of Educational and Behavioral Statistics, 40_(6), 604-634.
86 #' \doi{10.3102/1076998615606099}
87 #'
88
89 "dropoutPrevention"
90
91
92 #' State-level annual mortality rates by cause among 18-20 year-olds
93 #'
94 #' A dataset containing state-level annual mortality rates for select causes of
95 #' death, as well as data related to the minimum legal drinking age and alcohol
96 #' consumption.
97 #'
98 #' @format A data frame with 5508 rows and 12 variables: \describe{
99 #' \item{year}{Year of observation}
100 #' \item{state}{identifier for state}
101 #' \item{count}{Number of deaths}
102 #' \item{pop}{Population size}
103 #' \item{legal}{Proportion of 18-20 year-old population that is legally allowed to drink}
104 #' \item{beertaxa}{Beer taxation rate}
105 #' \item{beerpercap}{Beer consumption per capita}
106 #' \item{winepercap}{Wine consumption per capita}
107 #' \item{spiritpercap}{Spirits consumption per capita}
108 #' \item{totpercap}{Total alcohol consumption per capita}
109 #' \item{mrate}{Mortality rate per 10,000}
110 #' \item{cause}{Cause of death}
111 #' }
112 #'
113 #' @source
114 #' \href{https://masteringmetrics.com/wp-content/uploads/2015/01/deaths.dta}{Mastering
115 #' 'Metrics data archive}
116 #'
117 #' @references
118 #'
119 #' Angrist, J. D., and Pischke, J. S. (2014). _Mastering'metrics: the path from
120 #' cause to effect_. Princeton University Press, 2014.
121 #'
122 #' Carpenter, C., & Dobkin, C. (2011). The minimum legal drinking age and public
123 #' health. _Journal of Economic Perspectives, 25_(2), 133-156.
124 #' \doi{10.1257/jep.25.2.133}
125 #'
126
127 "MortalityRates"
128
129 #' Randomized experiments on SAT coaching
130 #'
131 #' Effect sizes from studies on the effects of SAT coaching,
132 #' reported in Kalaian and Raudenbush (1996)
133 #'
134 #' @format A data frame with 67 rows and 11 variables:
135 #' \describe{
136 #' \item{study}{Study identifier}
137 #' \item{year}{Year of publication}
138 #' \item{test}{Character string indicating whether effect size corresponds to outcome on verbal (SATV) or math (SATM) test}
139 #' \item{d}{Effect size estimate (Standardized mean difference)}
140 #' \item{V}{Variance of effect size estimate}
141 #' \item{nT}{Sample size in treatment condition}
142 #' \item{nC}{Sample size in control condition}
143 #' \item{study_type}{Character string indicating whether study design used a matched, non-equivalent, or randomized control group}
144 #' \item{hrs}{Hours of coaching}
145 #' \item{ETS}{Indicator variable for Educational Testing Service}
146 #' \item{homework}{Indicator variable for homework}
147 #' }
148 #'
149 #' @references Kalaian, H. A. & Raudenbush, S. W. (1996). A multivariate mixed
150 #' linear model for meta-analysis. \emph{Psychological Methods, 1}(3),
151 #' 227-235.
152 #' \doi{10.1037/1082-989X.1.3.227}
153 #'
154
155 "SATcoaching"