SGP (version 1.0-3.0)

outputSGP: Output student data and SGP results for a variety of purposes

Description

Utility function used to export student data and SGP results for a variety of purposes. Current functionality exports data in wide format for data visualization purposes. See source code for detailed functionality.

Usage

outputSGP(sgp_object,
	state=NULL,
        output.type=c("LONG_Data", "WIDE_Data"),
        baseline.sgps=FALSE,
        outputSGP_SUMMARY.years=NULL,
        outputSGP_SUMMARY.content_areas=NULL,
        outputSGP_INDIVIDUAL.years=NULL,
        outputSGP_INDIVIDUAL.content_areas=NULL,
        outputSGP.anonymize=FALSE,
        outputSGP.student.groups=NULL,
        outputSGP.directory="Data",
	outputSGP.translate.names=TRUE,
	outputSGP.projection.years.for.target=3)

Arguments

sgp_object

An object of class SGP containing data to be exported.

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 indicating the years to be included in the output. Default is to use all years.

content_areas

A vector indicating the content areas to be included in the output. Default is to use all content areas.

output.type

A character vector indicating what output type is requested. Currently LONG_Data, WIDE_Data, and SchoolView are supported modes of output. LONG_Data exports the contents of the @Data slot in a pipe de

baseline.sgps

Boolean vector indicating whether to output baseline SGPs for cohorts referenced SGPs.

outputSGP_SUMMARY.years

A vector indicating the year to be used for output file construction for summary tables.

outputSGP_SUMMARY.content_areas

A vector indicating the content areas to be used for output file construction for summary tables.

outputSGP_INDIVIDUAL.years

A vector indicating the year to be used for output file construction for individual level file.

outputSGP_INDIVIDUAL.content_areas

A vector indicating the content areas to be used for output file construction for individual level file.

outputSGP.anonymize

A boolean variable indicating whether to anonymize output files.

outputSGP.student.groups

A list of variables to be used for student groups in individual and summary tables.

outputSGP.directory

A a file path indicating where to save output files. Defaults to Data.

outputSGP.translate.names

A boolean argument, defaults to TRUE, indicating whether data output should refer to 'names.provided' or 'names.sgp' in @Names slot of supplied SGP object.

outputSGP.projection.years.for.target

An integer argument indicating what projection to supply with regard to the number of years projected forward.

Value

• Function returns an R object with data to be exported per user's desire (e.g., as a pipe delimited file).

See Also

abcSGP, prepareSGP, analyzeSGP, combineSGP, summarizeSGP

Examples

outputData <- outputSGP(Demonstration_Data)