SGP: outputSGP – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

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", "LONG_FINAL_YEAR_Data", "WIDE_Data", 
			"INSTRUCTOR_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,
	outputSGP.pass.through.variables=NULL)

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`, `INSTRUCTOR_Data`, `SchoolView`, `RLI` are supported modes of output. `LONG_Data` exports the contents of the @Data slot in a pipe delimited format. `LONG_FINAL_YEAR_Data` exports the contents of the last year of the @Data slot in a pipe delimited format. `WIDE_Data` exports a reshaped version of the @Data slot where each row is a unique student record. `INSTRUCTOR_Data` uses the `@Data_Supplementary$INSTRUCTOR_NUMBER` table to export a long student by instructor number table. `SchoolView` exports tables used for representation in SchoolView. `RLI` exports used for representation by RLI. The default exports `LONG_Data`, `LONG_FINAL_YEAR_Data`, `WIDE_Data` and `INSTRUCTOR_Data`.
`baseline.sgps`	Boolean vector indicating whether to output baseline SGPs for cohort referenced SGPs.
`outputSGP_SUMMARY.years`	A character vector indicating the year to be used for output file construction for summary tables.
`outputSGP_SUMMARY.content_areas`	A character vector indicating the content areas to be used for output file construction for summary tables.
`outputSGP_INDIVIDUAL.years`	A character vector indicating the year to be used for output file construction for individual level file.
`outputSGP_INDIVIDUAL.content_areas`	A character 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. This argument allows for the the conversion of variable naming conventions from the SGP package back to that used by the state/organization.
`outputSGP.projection.years.for.target`	An integer argument indicating what projection to supply with regard to the number of years projected forward.
`outputSGP.pass.through.variables`	A character vector of variables in @Data that are to be merged with output in RLI output.type. Default is NULL or no.

Value

Function writes data in multiple formats including .Rdata, .txt (pipe delimited) and zipped versions of .txt.

Author(s)

Damian W. Betebenner dbetebenner@nciea.org

Examples

## Not run: 
Demonstration_SGP <- prepareSGP(sgpData_LONG)
Demonstration_SGP <- analyzeSGP(Demonstration_SGP)
Demonstration_SGP <- combineSGP(Demonstration_SGP)
outputSGP(Demonstration_SGP)

## Output current year

outputSGP(Demonstration_SGP, output.type="LONG_FINAL_YEAR_Data")

## End(Not run)

SGP

Student Growth Percentiles & Percentile Growth Trajectories

v1.9-5.0

GPL-3

Authors

Damian W. Betebenner [aut, cre], Adam R. Van Iwaarden [aut], Ben Domingue [aut], Yi Shang [aut], Jonathan Weeks [ctb], John Stewart [ctb], Jinnie Choi [ctb], Xin Wei [ctb], Hi Shin Shim [ctb], Xiaoyuan Tan [ctb] (Arizona Department of Education), Carrie Giovannini [ctb] (Arizona Department of Education), Sarah Polasky [ctb] (Arizona State University), Rebecca Gau [ctb] (Arizona Charter School Association), Jeffrey Dean [ctb] (University of Arkansas), William Bonk [ctb] (Colorado Department of Education), Marie Huchton [ctb] (Colorado Department of Education), Allison Timberlake [ctb] (Georgia Department of Education), Qi Qin [ctb] (Georgia Department of Education), Melissa Fincher [ctb] (Georgia Department of Education), Kiran Athota [ctb] (Georgia Department of Education), Travis Allen [ctb] (Georgia Department of Education), Glenn Hirata [ctb] (Hawaii Department of Education), Glenn Nochi [ctb] (Hawaii Department of Education), Joshua Lee [ctb] (Hawaii Department of Education), Ayaka Nukui [ctb] (Idaho Department of Education), Carissa Miller [ctb] (Idaho Department of Education), Matthew Raimondi [ctb] (Elgin Area School District U46 (Illinois)), Wes Bruce [ctb] (Indiana Department of Education), Robert Hochsegang [ctb] (Indiana Department of Education), Tony Moss [ctb] (Kansas State Department of Education), Xuewen Sheng [ctb] (Kansas State Department of Education), Kathy Flanagan [ctb] (Massachusetts Department of Elementary and Secondary Education), Robert Lee [ctb] (Massachusetts Department of Elementary and Secondary Education), Ji Zeng [ctb] (Michigan Department of Education), Steve Viger [ctb] (Michigan Department of Education), Joe DeCastra [ctb] (Mississippi Department of Education), Ken Thompson [ctb] (Mississippi Department of Education), Soo Yeon Cho [ctb] (Missouri Department of Education), Jeff Halsell [ctb] (Clark County School District, Nevada), Selcuk Ozdemir [ctb] (Washoe County School District, Nevada), Roger Silva [ctb] (Nevada Department of Education), Deb Wiswell [ctb] (New Hampshire Department of Education), Katya Levitan-Reiner [ctb] (New Haven Public Schools), Catherine McCaslin [ctb] (New Haven Public Schools), Joshua Marland [ctb] (New York Education Department), W Joshua Rew [ctb] (Oregon Department of Education), Jason Becker [ctb] (Rhode Island Department of Education), Jessica Bailey [ctb] (Rhode Island Department of Education), Ana Karantonis [ctb] (Rhode Island Department of Education), Deborah Jonas [ctb] (Virginia Department of Education), Juan D'Brot [ctb] (West Virginia Department of Education), Nate Hixson [ctb] (West Virginia Department of Education), Deb Came [ctb] (Washington Office of Superintendent of Public Instruction), Ashley Colburn [ctb] (Washington Office of Superintendent of Public Instruction), Nick Hassell [ctb] (Washington Office of Superintendent of Public Instruction), Krissy Johnson [ctb] (Washington Office of Superintendent of Public Instruction), Daniel Bush [ctb] (Wisconsin Department of Education), Justin Meyer [ctb] (Wisconsin Department of Education), Joseph Newton [ctb] (Wisconsin Department of Education), Nick Stroud [ctb] (Wisconsin Department of Education), John Paul [ctb] (Wyoming Department of Education), Michael Flicek [ctb] (Michael Flicek Projects LLC working with Wyoming Department of Education), Phyllis Clay [ctb] (Albuquerque Public Schools), Peter Kinyua [ctb] (Albuquerque Public Schools), Brendan Houng [ctb] (University of Melbourne, Australia, NAPLAN), Leslie Rosale [ctb] (Ministry of Education, Guatemala), Nathan Wall [ctb] (eMetric working with Nevada Department of Education and South Dakota Department of Education), Narek Sahakyan [ctb] (World Class Instruction and Design (WIDA))

Initial release

2020-1-30