SGP (version 0.0-6.4)

summarizeSGP: Summarize student scale scores, proficiency levels and student growth percentiles according to user specified summary group variables

Description

Utility function used to produce summary tables using long formatted data that contain student growth percentiles. An exemplar is provided from the successive execution of prepareSGP, analyzeSGP and combineSGP.

Usage

summarizeSGP(sgp_object,
    years,
    content_areas,
    state="DEMO",
    sgp.summaries=list(MEDIAN_SGP="median_na(SGP)",
        MEDIAN_SGP_COUNT="num_non_missing(SGP)",
        PERCENT_AT_ABOVE_PROFICIENT=
            "percent_in_category(ACHIEVEMENT_LEVEL, list(c(1,4)), list(1:5))",
        PERCENT_AT_ABOVE_PROFICIENT_COUNT=
            "num_non_missing(ACHIEVEMENT_LEVEL)"),
    summary.groups=list(institution=c("STATE", "SCHOOL_NUMBER"),
        content="CONTENT_AREA",
        time="YEAR",
        institution_level="GRADE",
        demographic=c("GENDER", "ETHNICITY", "FREE_REDUCED_LUNCH_STATUS", 
            "ELL_STATUS", "CATCH_KEEP_UP"),
        institution_inclusion=list(STATE="OCTOBER_ENROLLMENT_STATUS", 
             SCHOOL_NUMBER="OCTOBER_ENROLLMENT_STATUS")),
    confidence.interval.groups=list(institution="SCHOOL_NUMBER",
        content="CONTENT_AREA",
        time="YEAR",
        institution_level= NULL,
        demographic=NULL,
        institution_inclusion=list(STATE=NULL, 
             SCHOOL_NUMBER="OCTOBER_ENROLLMENT_STATUS")))

Arguments

sgp_object

A list containing long formatted data in the Student slot. If summaries of student growth percentiles are requested, those quantities must first be produced (possibly by first using analyzeSGP

years

A vector indicating years in which to produce student growth percentiles and/or student growth projections/trajectories. If left missing the function will use the data to infer the years based upon the assumption of having at least three years of panel d

content_areas

A vector indicating content areas in which to produce student growth percentiles and/or student growth projections/trajectories. If left missing the function will use the data to infer the content areas available for analyses.

state

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

sgp.summaries

A list giving the summaries requested for each group analyzed based upon the summary.group argument. The default summaries include the group level MEDIAN_SGP, MEDIAN_SGP_COUNT (the number of students used to compute

summary.groups

A list consisting of 5 types of groups across which all summaries are taken, including the institution (e.g. state, districts and schools), content area, time, institution_level (usually grade), de

confidence.interval.groups

A list consisting of the group summaries for which confidence intervals should be constructed. This argument requires that simulated SGPs have been produced (see analyzeSGP for more information). List sl

Value

• Function returns lists containing the summary tables as data.table objects in the Summary slot of the SGP data object. Each institution has a slot in the Summary list.

Details

Function makes use of the foreach package to parallel process summary tables of student data. It is the user's responsibility to register a parallel backend of their choice before running the summarizeSGP function. The proper choice may be dependent upon the user's operating system, software and system memory capacity. Please see the foreach documentation for details. If no parallel backend is specified, the function will process the summary tables sequentially.

See Also

prepareSGP, analyzeSGP, combineSGP

Examples

## analyzeSGP is Step 4 of 5
DEMO_Data <- prepareSGP(sgpData_LONG)
DEMO_Data <- analyzeSGP(DEMO_Data)
DEMO_Data <- combineSGP(DEMO_Data)
DEMO_Data <- summarizeSGP(DEMO_Data)