Usage
summarizeSGP(sgp_object,
state,
years,
content_areas,
sgp.summaries=NULL,
summary.groups=NULL,
confidence.interval.groups=NULL,
produce.all.summary.tables=FALSE,
summarizeSGP.baseline=NULL,
projection.years.for.target=3,
save.old.summaries=FALSE,
parallel.config=NULL)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 state
Acronym indicating state associated with the summaries for access to assessment program information embedded in SGPstateData.
years
A vector indicating year(s) in which to produce summary tables associated with student growth percentile and percentile growth trajectory/projection analyses. If missing the
function will use the data to calculate years and produce summaries for the most
content_areas
A vector indicating content area(s) in which to produce student growth percentiles and/or student growth projections/trajectories.
If missing the function will use the data to infer the content area(s) available for analyses.
sgp.summaries
A list giving the summaries requested for each group analyzed based upon the summary.group argument. The default (produced internal to summarizeSGP) summaries include:
ll{
MEDIAN_SGP The group level median stu
summary.groups
A list consisting of 8 elements indicating the types of groups across which all summaries are taken (Inclusion means that summaries will be calculated for levels of the
associated variable). For state data, if the list is not explicitly provided, the fun
confidence.interval.groups
A list consisting of information used to calculate group confidence intervals:
ll{
TYPE: Either Bootstrap (default) or CSEM indicating Bootstrap confidence interval calculation (the default) or c
produce.all.summary.tables
A boolean variable, defaults to FALSE, indicating whether the function should produce ALL possible summary table. By default, a set of approximately 70 tables are produced that are used in other parts of the packages (e.g., bubblePlots).
summarizeSGP.baseline
A boolean variable, defaults to FALSE, indicating whether the function should utilize baseline sgp for summary table production. By default,
a set of approximately 100 tables are produced that are used in other parts of the packages (e.g., bubblePlots).
projection.years.for.target
An integer argument indicating SGP_TARGET variables to summarize based upon years projected forward. Default is 3 years which is what is generally used by
most states.
save.old.summaries
A boolean argument, defaults to FALSE, indicating whether to save the @Summary slot (if not NULL) prior to calculating new summaries. By defaulting to FALSE, the function
overwrites previous (e.g., last year's summaries) summaries.
parallel.config
A named list with, at a minimum, two elements indicating 1) the BACKEND package to be used for parallel computation and 2) the WORKERS list to specify the number of processors to be used in each major analysis. The BACKEND element can be set = to F