visualizeSGP: Visualize data from SGP analyses

Description

Utility function to produce a variety of graphical displays associated with student growth percentile/percentile growth trajectory results. Function currently includes facility to produce individual student growth and achievement plots, interactive bubble plots depicting summary growth and achievement data, and growth and achievement charts showing system level growth and achievement data as shown on the cover of Educational Measurement: Issues and Practice as part of Betebenner (2009).

Usage

visualizeSGP(
           sgp_object,
           plot.types=c("bubblePlot", "studentGrowthPlot", "growthAchievementPlot"),
           state,
           bPlot.years=NULL,
           bPlot.content_areas=NULL,
           bPlot.districts=NULL,
           bPlot.schools=NULL,
           bPlot.styles=c(1),
           bPlot.levels=NULL,
           bPlot.full.academic.year=TRUE,
           bPlot.minimum.n=10,
           bPlot.anonymize=FALSE,
           bPlot.prior.achievement=TRUE, 
           bPlot.draft=FALSE,
           bPlot.format="print",
           bPlot.folder="Visualizations/bubblePlots",
           sgPlot.save.sgPlot.data=FALSE,
           sgPlot.years=NULL,
           sgPlot.content_areas=NULL,
           sgPlot.districts=NULL,
           sgPlot.schools=NULL,
           sgPlot.students=NULL,
           sgPlot.reports.by.student=FALSE,
           sgPlot.header.footer.color="#4CB9CC",
           sgPlot.front.page=NULL,
           sgPlot.folder="Visualizations/studentGrowthPlots",
           sgPlot.folder.names="number",
           sgPlot.fan=TRUE,  
           sgPlot.anonymize=FALSE,
           sgPlot.cleanup=TRUE,
           sgPlot.demo.report=FALSE,
           sgPlot.produce.plots=TRUE,
           sgPlot.parallel.config=list(TYPE="FOREACH", OPTIONS=list(preschedule=FALSE)),
           gaPlot.years=NULL,
           gaPlot.content_areas=NULL,
           gaPlot.students=NULL,
           gaPlot.format="print",
           gaPlot.folder="Visualizations/growthAchievementPlots")

Arguments

sgp_object

An object of class SGP containing long formatted data in the Data slot that will be used for the production of student growth and achievement plots and system growth and achievement plots, summary data from

plot.types

A character vector indicating what types of plots to construct. Currently available plots include bubblePlot, studentGrowthPlot, and

state

Acronym indicating state associated with the summaries for access to assessment program information embedded in stateData.

bPlot.years

A vector indicating year(s) in which to produce bubblePlots using data available in sgp_object. If missing the function will use the last year available in the data to produce

bPlot.content_areas

A vector indicating content area(s) to produce bubblePlots using data available in sgp_object. If missing the function will produce plots for all available content areas provided in the dat

bPlot.districts

A vector indicating districts to produce bubblePlots using data available in sgp_object. Consult bubblePlot styles to determine which

bPlot.schools

A vector indicating schools to produce bubblePlots using data available in sgp_object. Consult bubblePlot styles to determine which

bPlot.styles

A vector of positive integers indicating the types of bubblePlots to produce using data available in sgp_object. See associated documentation for example plots.

bPlot.levels

A character vector of levels to be used to color bubbles in the bubblePlot. See associated documentation for example plots.

bPlot.full.academic.year

A boolean argument (defaults to TRUE) indicating whether bubblePlots should use full academic year results if available.

bPlot.minimum.n

A positive integer (defaults to 10) indicating the minimum size for summary values to be displayed in the bubblePlots.

bPlot.anonymize

A boolean argument (defaults to FALSE) indicating whether to anonymize bubblePlots school and district names that appear in the plots and data tips of the plots. For student level anonymization, the fun

bPlot.prior.achievement

A boolean argument (defaults to TRUE) indicating whether to produce bubblePlots using prior achievement as well as current achievement as the vertical dimension of the

bPlot.draft

A boolean argument (defaults to FALSE) indicating whether to put an indicator on the chart noting that the results are draft and to not distribute.

bPlot.format

Either "print" or "presentation" indicating whether to optimize the plot for print form (light background) or presentation form (dark background).

bPlot.folder

Character vector indicating where bubblePlots should be placed. Default folder is "Visualizations/bubblePlots".

sgPlot.save.sgPlot.data

A boolean argument indicating whether wide formatted data should be save as part of indivividual student report production. For operational student report production construction, using a wide formatted file for a large state can save in having to reshape

sgPlot.years

A vector indicating year for which to produce studentGrowthPlots. The supplied year indicates the final year associated with each student's

sgPlot.content_areas

A vector indicating the content areas for which to produce studentGrowthPlots. If missing, the function will utilize all available content areas.

sgPlot.districts

A vector indicating which districts to produce studentGrowthPlots for. If missing the function will use all available districts in the data to produce

sgPlot.schools

A vector indicating which schools to produce studentGrowthPlots for. If missing the function will use all available schools in the data to produce

sgPlot.students

A vector of student IDs indicating which students to produce studentGrowthPlots for. If missing the function will use all available students in the data to produce

sgPlot.reports.by.student

A boolean variable indicating whether the reports should be collated as single reports in a single folder or deposited into a district/school/grade folder hierarchy. The default is FALSE which puts the reports into their appropriate district/school/grade

sgPlot.header.footer.color

Character vector (default is blue) indicating the color of the header/footer associated with the studentGrowthPlot. Another good color is goldenrod2.

sgPlot.front.page

A path to a PDF to be used as the front page to the studentGrowthPlot. The default is missing so that no front page is attached to the studentGrowth

sgPlot.folder

Character vector indicating where studentGrowthPlots should be placed. Note that studentGrowthPlots are placed within nested folders wit

sgPlot.folder.names

Either "name" or "number" (the default) indicating how the nested folder structure will be labeled that holds the studentGrowthPlots.

sgPlot.fan

A boolean argument (defaults to TRUE) indicating whether to produce projection fan on studentGrowthPlots.

sgPlot.anonymize

A boolean argument (defaults to FALSE) indicating whether to anonymize studentGrowthPlots student, school and district names. For student level anonymization, the function utilizes the rand

sgPlot.cleanup

A boolean argument (defaults to TRUE) indicating whether to remove files produced by pdfLaTeX to produce studentGrowthPlot catalogs.

sgPlot.demo.report

A boolean argument (defaults to TRUE) indicating whether to just produce a sample studentGrowthPlot catalogs. Note: When producing studentGrowthPlot

sgPlot.produce.plots

A boolean argument (defaults to TRUE) indicating whether to produce studentGrowthPlots. Useful when one just wants to produce wide formatted data without the actual student growth plots.

sgPlot.parallel.config

A list indicating the TYPE of back end used for the parallel computation and OPTIONS that apply to that parallel back end. Default is to use FOREACH for the back end with OPTIONS=list(preschedule=FALSE)

gaPlot.years

A vector indicating year for which to produce growthAchievementPlots. If missing the function will use the last year available in the data to produce

gaPlot.content_areas

A vector indicating content area(s) to produce growthAchievementPlots using data available in sgp_object. If missing the function will produce plots for all available content are

gaPlot.students

A vector of student IDs indicating which students to produce growthAchievementPlots for. If missing the function will use all available students in the data to produce <

gaPlot.format

Either "print" or "presentation" indicating whether to optimize the plot for print form (light background) or presentation form (dark background).

gaPlot.folder

Character vector indicating where growthAchievementPlots should be placed. Default folder is "Visualizations/growthAchievementPlots".

Value

Function produces numerous (potentially hundreds of thousands) of pdf files in a folder structure specified by the user and supplied through arguments to the function.

References

Betebenner, D. W. (2009). Norm- and criterion-referenced student growth. Educational Measurement: Issues and Practice, 28(4):42-51.

Examples

Run this code

## visualizeSGP is Step 5 of 5 of abcSGP
Demonstration_Data <- sgpData_LONG
Demonstration_Data <- prepareSGP(Demonstration_Data)
Demonstration_Data <- analyzeSGP(Demonstration_Data)
Demonstration_Data <- combineSGP(Demonstration_Data)
Demonstration_Data <- summarizeSGP(Demonstration_Data)
visualizeSGP(Demonstration_Data)

## Production of sample student growth and achievement plots

visualizeSGP(
	sgp_object=Demonstration_Data, 
	plot.types="studentGrowthPlot",
	state="DEMO",
	sgPlot.districts=470,
	sgPlot.schools=c(6418, 8008),
	sgPlot.header.footer.color="#4CB9CC")

Run the code above in your browser using DataLab