viewSummaryGroups: View summary and confidence interval groups that will be used in `summarizeSGP`

Description

Utility function that produces a data.frame from the lists of user supplied summary and confidence interval group variables. Intended to complement summarizeSGP and promote proper group summary specification.

Usage

viewSummaryGroups(
        summary.groups=list(institution=c("STATE", "DISTRICT_NUMBER", "SCHOOL_NUMBER"),
                content="CONTENT_AREA",
                time="YEAR",
                institution_level="GRADE",
                demographic=c("GENDER", "ETHNICITY", "FREE_REDUCED_LUNCH_STATUS", "ELL_STATUS", "IEP_STATUS", "GIFTED_AND_TALENTED_PROGRAM_STATUS", "CATCH_UP_KEEP_UP_STATUS"),
                institution_inclusion=list(STATE="STATE_ENROLLMENT_STATUS", DISTRICT_NUMBER="DISTRICT_ENROLLMENT_STATUS", SCHOOL_NUMBER="SCHOOL_ENROLLMENT_STATUS")),
        confidence.interval.groups=list(institution="SCHOOL_NUMBER",
                content="CONTENT_AREA",
                time="YEAR",
                institution_level=NULL,
                demographic=NULL,
                institution_inclusion=list(STATE=NULL, DISTRICT_NUMBER=NULL, SCHOOL_NUMBER="SCHOOL_ENROLLMENT_STATUS")),
        confidence.interval.groups.only=FALSE)

Arguments

summary.groups

A list containing the grouping variables upon which to aggregate in summarizeSGP. This includes the institution, content area, time, institution_level

confidence.interval.groups

A list containing the grouping variables for which confidence intervals should be constructed in summarizeSGP. List slots set to NULL will not produce confidence intervals. NOTE: Groups to

confidence.interval.groups.only

Boolean variable indicating whether to show only those group combinations that will include a confidence interval for the Median SGP. Defaults to FALSE.

Value

Function returns data.frame containing the summary group permutations and a Boolean vector indicating whether or not the permutation will also have a 95% confidence interval provided when the summary table is produced using summarizeSGP.

Details

The user provides the arguments required by summarizeSGP in order to see the group permutations for which summary tables will be produced in summarizeSGP.

Examples

Run this code

## View only summary.groups combinations that will have confidence intervals
viewSummaryGroups(confidence.interval.groups.only=TRUE)