abcSGP(SGP)
abcSGP()所属R语言包：SGP
Perform 5 step sequence: prepareSGP, analyzeSGP, combineSGP, summarizeSGP, and visualizeSGP
执行5步的顺序：prepareSGP，analyzeSGP，combineSGP，summarizeSGP，visualizeSGP
译者：生物统计家园网 机器人LoveR
描述----------Description----------
Utility function to perform sequence of 6 steps going from data preparation, prepareSGP, SGP data analysis, analyzeSGP, data combining, combineSGP, data summarization, summarizeSGP, data visualization visualizeSGP and data output outputSGP.
效用函数执行序列的6个步骤，从数据准备，prepareSGP，的SGP数据分析，analyzeSGP，数据相结合，combineSGP，数据汇总，summarizeSGP，数据可视化visualizeSGP和数据输出outputSGP。
用法----------Usage----------
abcSGP(sgp_object,
state=NULL,
steps=c("prepareSGP", "analyzeSGP", "combineSGP", "summarizeSGP", "visualizeSGP", "outputSGP"),
years=NULL,
content_areas=NULL,
grades=NULL,
prepareSGP.var.names=NULL,
sgp.percentiles=TRUE,
sgp.projections=TRUE,
sgp.projections.lagged=TRUE,
sgp.percentiles.baseline=TRUE,
sgp.projections.baseline=TRUE,
sgp.projections.lagged.baseline=TRUE,
simulate.sgps=TRUE,
parallel.config=NULL,
save.intermediate.results=FALSE,
sgPlot.demo.report=FALSE,
sgp.summaries=NULL,
summary.groups=NULL,
confidence.interval.groups=NULL,
plot.types=c("bubblePlot", "studentGrowthPlot", "growthAchievementPlot"))
参数----------Arguments----------
参数：sgp_object
A list containing LONG formatted data. See sgpData_LONG for an exemplar. NOTE: Data preparation must be meticulous to utilize this enhanced functionality.
一个列表，其中包含LONG格式的数据。见sgpData_LONG的典范。注：数据准备必须一丝不苟地利用这个增强的功能。
参数：state
Acronym indicating state associated with the data for access to embedded knot and boundaries, cutscores, CSEMs, and other relevant state level data.
首字母缩写，表示状态与嵌入式结和边界，cutscores，CSEMs，以及其他相关的国家一级数据访问的数据。
参数：steps
Vector containing all or some subset of prepareSGP, analyzeSGP, combineSGP, summarizeSGP, visualizeSGP indicating what steps the user wants accomplished. Default is to perform all steps.
Vector，其中包含全部或部分子集prepareSGP，analyzeSGP，combineSGP，summarizeSGP，visualizeSGP说明什么步骤，用户想要完成的。默认设置是执行所有步骤。
参数：years
A vector indicating year(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 year(s) in which to perform growth percentile analyses based upon the assumption of having at least three years of panel data for analyses.
一个矢量年（S），其中以学生的成长百分位值和/或学生的成长预测/轨迹。如果没有的功能将利用这些数据来推断今年（s）在执行具有至少3年的面板数据进行分析的假设基础上的增长百分分析。
参数：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.
A向量说明的内容面积（S），在其中学生的成长百分位值和/或学生的成长预测/轨迹。如果缺少该功能将利用这些数据来推断的内容进行分析的面积（S）。
参数：grades
A vector indicating grades for which to calculate student growth percentiles and/or student growth projections/trajectories. If missing the function will use the data to infer all the grade progressions for student growth percentile and student growth projections/trajectories analyses.
一个向量，表示牌号为学生的成长百分位值和/或学生的成长预测/轨迹计算。如果缺少该功能将利用这些数据来推断所有等级的级数为学生的成长百分位数和学生的成长预测/轨迹分析。
参数：prepareSGP.var.names
list supplied to prepareSGP mapping provided variable names to variable names required as part of the SGP package. See prepareSGP for more details. Defaults to NULL.
列表提供给prepareSGP映射提供了变量名的变量名作为SGP包的一部分需要。见prepareSGP更多详情。默认设置为NULL。
参数：sgp.percentiles
Boolean variable indicating whether to calculate student growth percentiles. Defaults to TRUE.
布尔变量，表示是否计算学生的成长百分。默认为true。
参数：sgp.projections
Boolean variable indicating whether to calculate student growth projections. Defaults to TRUE.
布尔变量，表示是否计算学生的成长预测。默认为true。
参数：sgp.projections.lagged
Boolean variable indicating whether to calculate lagged student growth projections often used for growth to standard analyses. Defaults to TRUE.
通常用于布尔变量，表示是否计算落后于学生的成长预测增长到标准的分析。默认为true。
参数：sgp.percentiles.baseline
Boolean variable indicating whether to calculate baseline student growth percentiles and/or coefficient matrices. Defaults to TRUE.
布尔变量，表示是否计算基准学生的成长百分位值和/或系数矩阵。默认为true。
参数：sgp.projections.baseline
Boolean variable indicating whether to calculate baseline student growth projections. Defaults to TRUE.
布尔变量，表示是否计算基准学生的成长预测。默认为true。
参数：sgp.projections.lagged.baseline
Boolean variable indicating whether to calculate lagged baseline student growth projections. Defaults to TRUE.
布尔变量，表示是否落后于基准计算学生的成长预测。默认为true。
参数：simulate.sgps
Boolean variable indicating whether to simulate SGP values for students based on test-specific Conditional Standard Errors of Measurement (CSEM). Test CSEM data must be available for simulation. Must be set to TRUE for confidence interval construction. Defaults to TRUE in abcSGP only.
布尔变量，表示是否模拟SGP值根据具体的测试条件标准误差的测量（CSEM）的学生。进行模拟测试CSEM数据必须是可用。必须设置为TRUE的置信区间施工。默认为TRUE abcSGP只有。
参数：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 FOREACH, SNOW, MULTICORE, or PARALLEL. Please consult the manuals and vignettes for information of these packages! The parallel.config list is passed to analyzeSGP, summarizeSGP and visualizeSGP. The WORKERS list can accordingly contain elements for PERCENTILES, PROJECTIONS, LAGGED_PROJECTIONS, BASELINE_MATRICES, BASELINE_PERCENTILES for analyzeSGP, SUMMARY for summarizeSGP and GA_PLOTS and SG_PLOTS for visualizeSGP. See those functions help pages for details.
命名列表，至少两个元素的指示1）的后端封装，可用于并行计算和2）工人列表中指定的处理器中使用的每个主要分析。后端元素可以被设置为FOREACH，SNOW，MULTICORE或PARALLEL。请参考手册和护身符的信息，这些包的！ parallel.config列表传递到analyzeSGP，summarizeSGP和visualizeSGP。工人也相应地包含的元素百分位推算，LAGGED_PROJECTIONS，BASELINE_MATRICES，BASELINE_PERCENTILES为analyzeSGP，summarizeSGP和GA_PLOTS和SG_PLOTS为visualizeSGP概要。这些功能的详细信息，帮助页面。
参数：save.intermediate.results
Should intermediate results of abcSGP be saved after each of prepareSGP, analyzeSGP, combineSGP, and summarizeSGP. Default is FALSE.
应的中间结果abcSGP保存后，每个prepareSGP，analyzeSGP，combineSGP和summarizeSGP。默认值是false。
参数：sgPlot.demo.report
A boolean variable (defaults to FALSE) indicating whether to produce only the demonstration student report catalog. Default is to produce reports for entire current year data.
一个布尔变量指示是否只生产示范学生报告目录（默认为false）。默认是整个本年度报告数据。
参数：sgp.summaries
A list giving the summaries requested for each group analyzed based upon the summary.group argument. Default is NULL allowing the summarizeSGP function to produce the list of summaries automatically.
一个列表，给出的总结分析各组根据summary.group参数要求。 summarizeSGP函数来产生摘要的列表会自动默认值为NULL。
参数：summary.groups
A list consisting of 8 types of groups across which all summaries are taken: institution, content, time, institution_type, institution_level, demographic, and institution_inclusion. Summaries generated in summarizeSGP are for all possible combinations of the 8 types of group. See documentation for summarizeSGP and viewSummaryGroups for more detail.
列表包括8种类型的群体有一个总结：institution，content，time，institution_type，institution_level，demographic和institution_inclusion。摘要中产生summarizeSGP的8种类型的组的所有可能的组合。 summarizeSGP和viewSummaryGroups更多详细信息，请参阅文档。
参数：confidence.interval.groups
A subset of the groups provided in the summary.groups argument indicating which groups to provide confidence intervals for. See documentation for summarizeSGP and viewSummaryGroups for more detail.
组提供的summary.groups参数说明哪些群体提供的置信区间的一个子集。 summarizeSGP和viewSummaryGroups更多详细信息，请参阅文档。
参数：plot.types
A character vector passed to visualizeSGP indicating the types of plots to produce. Currently supported plots include bubblePlots, studentGrowthPlots, and growthAchievementPlots.
字符向量传递给visualizeSGP指示类型的图产生的。目前支持的图包括bubblePlot，studentGrowthPlot的，和growthAchievementPlot的。
值----------Value----------
Function returns a list containing the input long data set in the Student slot as a data.table keyed using VALID_CASE, CONTENT_AREA, YEAR, ID, SGP results including student growth percentile and student growth projections/trajectories in the SGP slot, and summary results in the Summary slot.
函数返回一个列表，其中包含一个data.table键入使用Student，VALID_CASE，CONTENT_AREA的YEAR插槽设置在输入的数据，ID，SGP结果，包括学生的成长百分位数和学生的成长预测/ SGP插槽轨迹，并在总结插槽的汇总结果。
（作者）----------Author(s)----------
Damian W. Betebenner <a href="mailto:dbetebenner@nciea.org">dbetebenner@nciea.org</a>
参见----------See Also----------
prepareSGP, analyzeSGP, combineSGP, summarizeSGP, <br>
prepareSGP，analyzeSGP，combineSGP，summarizeSGP，参考
实例----------Examples----------
## Not run: [＃不运行：]
## Runs all 5 steps[＃运行所有的5个步骤]
Demonstration_SGP <- abcSGP(sgp_object=sgpData_LONG, state="DEMO")
## Or letting the function detect the state[＃或者让功能的状态检测]
Demonstration_SGP <- sgpData_LONG
Demonstration_SGP <- abcSGP(Demonstration_SGP)
###[＃＃]
### Example uses of the parallel.config argument[＃＃示例使用的parallel.config参数]
###[＃＃]
Demonstration_SGP <- sgpData_LONG
Demonstration_SGP <- abcSGP(Demonstration_SGP,
parallel.config=list(
BACKEND="PARALLEL", TYPE="SOCK",
WORKERS=list(
PERCENTILES=8, BASELINE_PERCENTILES=8, PROJECTIONS=7, LAGGED_PROJECTIONS=6,
SUMMARY=8,
GA_PLOTS=8, SG_PLOTS=8)
)
)
## End(Not run)[＃（不执行）]
转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。
注：
注1：为了方便大家学习，本文档为生物统计家园网机器人LoveR翻译而成，仅供个人R语言学习参考使用，生物统计家园保留版权。
注2：由于是机器人自动翻译，难免有不准确之处，使用时仔细对照中、英文内容进行反复理解，可以帮助R语言的学习。
注3：如遇到不准确之处，请在本贴的后面进行回帖，我们会逐渐进行修订。
|
发表于 2012-9-30 01:47:26
