Utility function that merges student long data in the @Data slot with results from student growth percentiles and/or student growth projections calculations.
Default values of this function are designed to be used following use of other utility functions:
Function is integrated with cutscores embedded in
SGPstateData to calculate growth-to-standard SGP targets and their associated scale scores
with catch-up/keep-up to proficient status and/or move-up/stay-up to advanced status as well as the scale scores associated with these targets.
combineSGP(sgp_object, state=NULL, years=NULL, content_areas=NULL, sgp.percentiles=TRUE, sgp.percentiles.baseline=TRUE, sgp.projections=TRUE, sgp.projections.baseline=TRUE, sgp.projections.lagged=TRUE, sgp.projections.lagged.baseline=TRUE, sgp.target.scale.scores=FALSE, sgp.target.scale.scores.only=FALSE, sgp.target.scale.scores.merge=FALSE, sgp.target.content_areas=NULL, max.sgp.target.years.forward=3, update.all.years=FALSE, sgp.config=NULL, sgp.percentiles.equated=NULL, SGPt=NULL, fix.duplicates=NULL, parallel.config=NULL)
An object of class SGP containing slots
Acronym for which state is to be used for the lagged projections and growth to standard analyses. Function will try to guess state name from passed
A vector of years indicating years of data to merge with
A vector of content areas indicating content areas of student growth percentile data to merge with
A Boolean variable indicating whether to combine student growth percentiles.
A Boolean variable indicating whether to combine baseline student growth percentiles.
A Boolean variable indicating whether to combine current year student growth projections and calculate catch-up/keep-up and move-up/stay-up values.
A Boolean variable indicating whether to combine current year baseline student growth projections and calculate catch-up/keep-up and move-up/stay-up values.
A Boolean variable indicating whether to combine lagged student growth projections and calculate catch-up/keep-up and move-up/stay-up values.
A Boolean variable indicating whether to combine lagged baseline student growth projections and calculate catch-up/keep-up move-up/stay-up values.
A Boolean variable indicating whether scale scores from calculated SGP targets should be calculated.
A Boolean variable indicating whether combineSGP should skip merging and only calculate scale scores from calculated SGP targets. Default is FALSE.
An argument (defaults to FALSE) indicating whether & how target scale scores should be merged with the LONG data in the @Data slot.
A Boolean variable indicating whether content area associated with SGP targets should be calculated.
A integer indicating the number of years forward from the lagged (last year's) score to project forward for growth to standard calculations. Default is 3 years from the present, 4 years from the lagged year, which is the standard in most growth to standard calculations used by state departments of education.
A Boolean argument defaulting to FALSE indicating whether
Argument (defaults to NULL) passed utilized only for target scale score calculation. If targets for end of course tests are required, user must specify configurations
directly. See code from
Boolean variable indicating whether equated percentiles are being merged (defaults to NULL which is converted to FALSE unless otherwise explicitly declared. If scale score targets are being calculated, linkages will be passed to scale score targets for calculation.
Argument used to pass SGPt configuration to
Argument to control how duplicate records based upon the key of VALID_CASE, CONTENT_AREA, YEAR, and ID are dealt with.
If set to 'KEEP.ALL', the function tries to fix the duplicate individual records. If present and a '_DUP_***' suffix has been added to the
duplicate ID before running
Parallel configuration only used when 'sgp.target.scale.scores' is set to TRUE. Default is NULL consistent with no targets being calculated. To utilize parallel processing in the calculation of SGP scale score targets user must specify a list designating a backend (e.g, BACKEND='PARALLEL') and a number of workers (e.g., 'WORKERS=list(SGP_SCALE_SCORE_TARGETS=4)').
Function returns a list containing the input long data set in the
@Data slot as a
data.table keyed using
ID merged with student growth percentiles and/or straight/lagged projection targets and catch-up/keep-up and move-up/stay-up status with, if requested, the scale scores
associated with such targets.