Perform 6 step sequence: prepareSGP, analyzeSGP, combineSGP, summarizeSGP, visualizeSGP, and outputSGP
Utility function to perform sequence of 6 steps going from data preparation, prepareSGP
, SGP data analysis, analyzeSGP
,
data combining, combineSGP
, data summary, summarizeSGP
, data visualization visualizeSGP
and data output
outputSGP
.
abcSGP(sgp_object, state=NULL, steps=c("prepareSGP", "analyzeSGP", "combineSGP", "summarizeSGP", "visualizeSGP", "outputSGP"), years=NULL, content_areas=NULL, grades=NULL, prepareSGP.var.names=NULL, prepareSGP.create.additional.variables=FALSE, sgp.percentiles=TRUE, sgp.projections=TRUE, sgp.projections.lagged=TRUE, sgp.percentiles.baseline=TRUE, sgp.projections.baseline=TRUE, sgp.projections.lagged.baseline=TRUE, sgp.use.my.coefficient.matrices=NULL, sgp.minimum.default.panel.years=NULL, sgp.target.scale.scores=FALSE, sgp.target.scale.scores.only=FALSE, sgp.test.cohort.size=NULL, return.sgp.test.results=FALSE, simulate.sgps=TRUE, calculate.simex=NULL, calculate.simex.baseline=NULL, goodness.of.fit.print=TRUE, parallel.config=NULL, save.intermediate.results=FALSE, save.old.summaries=FALSE, sgPlot.demo.report=FALSE, sgp.config=NULL, sgp.summaries=NULL, summary.groups=NULL, data_supplementary=NULL, confidence.interval.groups=NULL, plot.types=c("bubblePlot", "studentGrowthPlot", "growthAchievementPlot"), outputSGP.output.type=c("LONG_Data", "LONG_FINAL_YEAR_Data", "WIDE_Data", "INSTRUCTOR_Data"), outputSGP.directory="Data", verbose.output=FALSE, sgp.sqlite=FALSE, sgp.percentiles.equated=NULL, sgp.percentiles.equating.method=NULL, sgp.percentiles.calculate.sgps=TRUE, get.cohort.data.info=FALSE, SGPt=NULL, fix.duplicates=NULL)
sgp_object |
A list containing LONG formatted data. See |
state |
Acronym indicating state associated with the data for access to embedded knot and boundaries, cutscores, CSEMs, and other relevant state level data. This can be supplied to the function
automatically by including the full state name (e.g, New_Hampshire_SGP) in the name of the object supplied to |
steps |
Vector containing all or some subset of |
years |
A vector indicating year(s) in which to produce student growth percentiles and/or student growth projections/trajectories. If missing the function will use the data to infer the year(s) in which to perform growth percentile analyses based upon the assumption of having at least three years of panel data for analyses. |
content_areas |
A vector indicating content area(s) in which to produce student growth percentiles and/or student growth projections/trajectories. If missing the function will use the data to infer the content area(s) available for analyses. |
grades |
A vector indicating grades for which to calculate student growth percentiles and/or student growth projections/trajectories. If missing the function will use the data to infer all the grade progressions for student growth percentile and student growth projections/trajectories analyses. |
prepareSGP.var.names |
list supplied to prepareSGP mapping provided variable names to variable names required as part of the SGP package. See |
prepareSGP.create.additional.variables |
Boolean variable indicating whether prepareSGP should create addition variables (e.g., ACHIEVEMENT_LEVEL) if they are missing. |
sgp.percentiles |
Boolean variable indicating whether to calculate student growth percentiles. Defaults to TRUE. |
sgp.projections |
Boolean variable indicating whether to calculate student growth projections. Defaults to TRUE. |
sgp.projections.lagged |
Boolean variable indicating whether to calculate lagged student growth projections often used for growth to standard analyses. Defaults to TRUE. |
sgp.percentiles.baseline |
Boolean variable indicating whether to calculate baseline student growth percentiles and/or coefficient matrices. Defaults to TRUE. |
sgp.projections.baseline |
Boolean variable indicating whether to calculate baseline student growth projections. Defaults to TRUE. |
sgp.projections.lagged.baseline |
Boolean variable indicating whether to calculate lagged baseline student growth projections. Defaults to TRUE. |
sgp.use.my.coefficient.matrices |
Boolean variable indicating whether to use embedded coefficient matrices to calculate SGPs. One should be careful to remove previously calculated SGPs prior to recalculating SGPs. |
sgp.minimum.default.panel.years |
Integer indicating the minimum number of panel years to begin with in the calculation of student growth percentiles. The default is NULL (converted to 3 years). |
sgp.target.scale.scores |
Boolean variable passed to |
sgp.target.scale.scores.only |
Boolean variable passed to |
sgp.test.cohort.size |
Integer indicating the maximum number of students sampled from the full cohort to use in the calculation of student growth percentiles. Intended to be used as a test of the desired analyses to be run. The default, NULL, uses no restrictions (no tests are performed, and analyses use the entire cohort of students). |
return.sgp.test.results |
Boolean variable passed to |
simulate.sgps |
Boolean variable indicating whether to simulate SGP values for students based on test-specific Conditional Standard Errors of Measurement (CSEM).
Test CSEM data must be available for simulation. Must be set to TRUE for confidence interval construction. Defaults to TRUE in |
calculate.simex |
A character state acronym or list including state/csem variable, csem.data.vnames, csem.loss.hoss, simulation.iterations, lambda and extrapolation method.
Returns both SIMEX adjusted SGP ( |
calculate.simex.baseline |
A character state acronym or list including state/csem variable, csem.data.vnames, csem.loss.hoss, simulation.iterations, lambda and extrapolation method. Defaults to NULL, no simex calculations performed.
Alternatively, setting the argument to TRUE uses the same defaults as above along with |
goodness.of.fit.print |
Boolean variable passed to |
parallel.config |
A named list with, at a minimum, two elements indicating 1) the BACKEND package to be used for parallel computation and 2) the WORKERS list to specify the number of processors to be used in each major analysis. The BACKEND element can be set = to The parallel.config list is passed to |
save.intermediate.results |
Should intermediate results of |
save.old.summaries |
A Boolean argument (defaults to FALSE which will delete the |
sgPlot.demo.report |
A Boolean variable (defaults to FALSE) indicating whether to produce only the demonstration student report catalog. Default is to produce reports for entire current year data. |
sgp.config |
Configuration passed to |
sgp.summaries |
A list giving the summaries requested for each group analyzed based upon the |
summary.groups |
A list consisting of 8 types of groups across which all summaries are taken: |
data_supplementary |
A list argument (or NULL, the default) providing additional multiple membership lookup tables for |
confidence.interval.groups |
A subset of the groups provided in the |
plot.types |
A character vector passed to |
outputSGP.output.type |
An argument passed to outputSGP indicating the output types to be produced. Defaults to |
outputSGP.directory |
A a file path indicating where to save output files. Defaults to |
verbose.output |
A Boolean argument indicating whether the function should output verbose diagnostic messages. |
sgp.sqlite |
A Boolean argument (defaults to FALSE) indicating whether a SQLite database file of the essential SGP data should be created from the |
sgp.percentiles.equated |
A Boolean argument (defaults to NULL, which calculates equated results if in the equating year) passed to |
sgp.percentiles.equating.method |
Character vector argument passed to |
sgp.percentiles.calculate.sgps |
Boolean argument passed to |
get.cohort.data.info |
Boolean argument passd to |
SGPt |
Argument (defaults to NULL) indicating whether to perform time dependent SGP analyses (SGPt). |
fix.duplicates |
Argument to control how |
Function returns a list containing the input long data set in the @Data
slot as a data.table keyed using VALID_CASE
, CONTENT_AREA
,
YEAR
, ID
, SGP results including student growth percentile and student growth projections/trajectories in the SGP slot, and summary results in the
@Summary
slot.
Damian W. Betebenner dbetebenner@nciea.org and Adam Van Iwaarden vaniwaarden@colorado.edu
## Not run: ## Runs all 5 steps Demonstration_SGP <- abcSGP(sgp_object=sgpData_LONG, state="DEMO") ## Or letting the function detect the state. Demonstration_SGP <- abcSGP(sgpData_LONG) ### ### Example uses of the parallel.config argument ### Demonstration_SGP <- abcSGP(sgpData_LONG, parallel.config=list( BACKEND="PARALLEL", TYPE="PSOCK", WORKERS=list( PERCENTILES=8, BASELINE_PERCENTILES=8, PROJECTIONS=7, LAGGED_PROJECTIONS=6, SUMMARY=8, GA_PLOTS=8, SG_PLOTS=8) ) ) ## End(Not run)
Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.