SGP (version 0.9-9.0)

combineSGP: Combine student data and SGP results

Description

Utility function/exemplar used to merge student long data 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: prepareSGP and analyzeSGP.

Usage

combineSGP(sgp_object,
	state=NULL,
	years=NULL,
	content_areas=NULL,
	sgp.percentiles=TRUE,
        sgp.percentiles.baseline=TRUE,
	sgp.projections.lagged=TRUE,
        sgp.projections.lagged.baseline=TRUE,
	max.lagged.sgp.target.years.forward=4,
	use.cohort.for.baseline.when.missing=NULL)

Arguments

sgp_object

A list containing both Student (from prepareSGP) and SGP (from analyzeSGP) slots.

state

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 sgp_object is missing.

years

A vector of years indicating years of data to merge with @Data. If missing, merge will use all available years of student growth percentile results.

content_areas

A vector of content areas indicating content areas of student growth percentile data to merge with @Data. If missing, merge will use all available content areas of student growth percentile results.

sgp.percentiles

A boolean variable indicating whether to combine student growth percentiles.

sgp.percentiles.baseline

A boolean variable indicating whether to combine baseline student growth percentiles.

sgp.projections.lagged

A boolean variable indicating whether to combine lagged student growth projections and calculate catch-up/keep-up values.

sgp.projections.lagged.baseline

A boolean variable indicating whether to combine lagged baseline student growth projections and calculate catch-up/keep-up values.

max.lagged.sgp.target.years.forward

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 4 years from last year or 3 years from present, which is the standard in most growth to standard calcul

use.cohort.for.baseline.when.missing

A boolean variable defaulting to FALSE/NULL indicating whether cohort referenced SGPs are to be used in place of baseline referenced SGPs when baseline referenced SGPs are not available.

Value

• Function returns a list containing the input long data set in the Student slot as a data.table keyed using VALID_CASE, CONTENT_AREA, YEAR, ID merged with student growth percentiles and/or lagged projection targets and catch up/keep up status.

See Also

prepareSGP, analyzeSGP

Examples

## combineSGP is Step 3 of 5 of abcSGP
Demonstration_SGP <- sgpData_LONG
Demonstration_SGP <- prepareSGP(Demonstration_SGP)
Demonstration_SGP <- analyzeSGP(Demonstration_SGP)
Demonstration_SGP <- combineSGP(Demonstration_SGP)