Usage
updateSGP(
what_sgp_object=NULL,
with_sgp_data_LONG=NULL,
state=NULL,
steps=c("prepareSGP", "analyzeSGP", "combineSGP",
"summarizeSGP", "visualizeSGP", "outputSGP"),
years=NULL,
content_areas=NULL,
grades=NULL,
sgp.percentiles=TRUE,
sgp.projections=TRUE,
sgp.projections.lagged=TRUE,
sgp.percentiles.baseline=TRUE,
sgp.projections.baseline=TRUE,
sgp.projections.lagged.baseline=TRUE,
simulate.sgps=FALSE,
save.old.summaries=TRUE,
save.intermediate.results=TRUE,
calculate.simex=NULL,
calculate.simex.baseline=NULL,
sgp.use.my.coefficient.matrices=NULL,
sgp.target.scale.scores=FALSE,
overwrite.existing.data=FALSE,
sgPlot.demo.report=TRUE,
sgp.config=NULL,
parallel.config=NULL,
...)Arguments
what_sgp_object
The SGP object to which the additional data will be added and analyzed. This object must be specified.
with_sgp_data_LONG
The additional data in LONG for to be added to the supplied object of class SGP analyzed. The additional data must be in the same form as the data in the @Data slot. If with_sgp_data_LONG is not supplied, the function with update the sgp_object supplied i
state
The 'state' for the sgp_object. Derived from sgp_object name if not explicitly supplied.
steps
A vector indicting the steps abcSGP will perform as part of the update. Defaults to all steps: prepareSGP, analyzeSGP, years
If only 'what_sgp_object' is supplied, years specifies the years to be run amongst those in the provided sgp_object.
content_areas
If only 'what_sgp_object' is supplied, content_areas specifies the content areas to be run amonst those provided by the coefficient matrices in the sgp_object. Default is to run all analyses associated with the coefficient matrices.
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 pr
sgp.percentiles
Boolean variable indicating whether to calculate student growth percentiles (if analyzeSGP is included in the 'steps' argument). Defaults to TRUE.
sgp.projections
Boolean variable indicating whether to calculate student growth projections (if analyzeSGP is included in the 'steps' argument). Defaults to TRUE.
sgp.projections.lagged
Boolean variable indicating whether to calculate lagged student growth projections often used for growth to standard analyses (if analyzeSGP is included in the 'steps' argument). Defaults to TRUE.
sgp.percentiles.baseline
Boolean variable indicating whether to calculate baseline student growth percentiles and/or coefficient matrices (if analyzeSGP is included in the 'steps' argument). Defaults to TRUE.
sgp.projections.baseline
Boolean variable indicating whether to calculate baseline student growth projections (if analyzeSGP is included in the 'steps' argument). Defaults to TRUE.
sgp.projections.lagged.baseline
Boolean variable indicating whether to calculate lagged baseline student growth projections (if analyzeSGP is included in the 'steps' argument). Defaults to TRUE.
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 and included in SGPstateData. This argument mu
save.old.summaries
A Boolean argument (defaults to FALSE which will delete the @Summary slot before creating new summaries)
indicating whether the call to summarizeSGP should save existing summaries in the save.intermediate.results
A Boolean argument (defaults to FALSE) indicating whether results should be save to the current directory after each step of the analysis.
calculate.simex
A character state acronym or list including state/csem variable, simulation.iterations, lambda and extrapolation method. Defaults to NULL, no simex calculations performed. Alternatively, setting the argument to TRUE sets the list up with state=state, lam
calculate.simex.baseline
A character state acronym or list including state/csem variable, simulation.iterations, lambda and extrapolation method. Defaults to NULL, no simex calculations performed. Alternatively, setting the argument to TRUE sets the list up with state=state, lam
sgp.use.my.coefficient.matrices
A Boolean argument (defaults to FALSE/NULL) passed to analyzeSGP indicating whether previous coefficient matrices should be used as
part of the analyses. sgp.target.scale.scores
A Boolean argument (defaults to FALSE/NULL) passed to combineSGP indicating whether to calculate scale scores associated with SGP targets as
part of the analyses. overwrite.existing.data
A Boolean argument (defaults to FALSE) indicating whether updateSGP should overwrite existing data/results from an earlier run as part of updateSGP.
sgPlot.demo.report
A Boolean argument (defaults to TRUE) indicating whether updateSGP should produce just the demo student growth plots or those associated with all students in the last year.
sgp.config
List of analysis control parameters passed to analyzeSGP. For details on this argument see document for that function. ...
Arguments to be passed to abcSGP for finer control over SGP calculations. For example, 'parallel.config' can be supplied to abcSGP for parallel computation.