R语言 SGP包 baselineSGP()函数中文帮助文档(中英文对照)

loveR

baselineSGP(SGP)
baselineSGP()所属R语言包：SGP

                                        Analyze student data to produce student growth percentiles and coefficient matrices from a baseline (i.e. multiple cohort) norm group
                                         分析学生的数据，从基线（即多个队列），规范组学生的成长百分位值和系数矩阵

                                         译者：生物统计家园网 机器人LoveR

描述----------Description----------

Utility function/exemplar used to produce student growth percentiles using long formatted data like that provided by prepareSGP. Used as part of analyzeSGP for baseline refeenced student growth percentile analyses.
实用功能/模范用于生产学生的成长百分使用长格式的数据，如提供的prepareSGP。的analyzeSGP基线refeenced学生的增长百分位分析的一部分。


用法----------Usage----------


baselineSGP(sgp_object,
        state,
        years,
        content_areas,
        grades,
        sgp.config,
        sgp.baseline.config,
        sgp.percentiles.baseline.max.order=3,
        return.matrices.only=FALSE,
        calculate.baseline.sgps=TRUE,
        goodness.of.fit.print=TRUE,
        ...)



参数----------Arguments----------

参数：sgp_object
An object of class SGP containing long formatted data in the Data (from prepareSGP) slot.   
类的一个对象SGP包含长Data（prepareSGP）插槽格式的数据。


参数：state
Acronym indicating state associated with the data for access to embedded knot and boundaries.  
首字母缩写，表示状态的数据访问嵌入式结和边界相关联。


参数：years
A vector indicating year(s) in which to produce baseline referenced student growth percentiles.   
一个矢量（s）在今年的基准参考学生的成长百分。


参数：content_areas
A vector indicating content area in which to produce baseline referenced student growth percentiles.   
一个向量，说明的内容领域，在其中的基准参考学生的成长百分。


参数：grades
A vector indicating which grades to calculate baseline referenced student growth percentiles.   
一个向量的成绩计算基准参考学生的成长百分。


参数：sgp.config
If years, content_areas, and grades are missing, user can directly specify a list containing three vectors: baseline.content.areas, baseline.panel.years, and baseline.grade.sequences. This advanced option is helpful for analysis of non-traditional grade progressions and other special cases. See analyzeSGP for use cases.  
如果years，content_areas和grades缺少，用户可以直接指定一个列表，其中包含三个向量：baseline.content.areas，baseline.panel.years和baseline.grade.sequences 。这种先进的选项，非传统的等级级数和其他特殊情况的分析是有帮助的。见analyzeSGP：用例。


参数：sgp.baseline.config
A list containing three vectors: sgp.content.areas, sgp.panel.years, sgp.grade.sequences indicating how baseline student growth percentile analyses are to be conducted. In most cases this value will be calculated by default within the function but can be specified directly for advanced use cases. See source code for more detail on this configuration option.  
一个列表，其中包含三个向量：sgp.content.areas，sgp.panel.years，sgp.grade.sequences表明基线学生的增长百分分析是如何进行的。在大多数情况下，这个值将被计算默认情况下，在该函数中，但可以直接指定为高级用例。此配置选项的更多详细信息，请参阅源代码。


参数：sgp.percentiles.baseline.max.order
Integer indicating the maximum order to calculate baseline student growth percentiles (regardless of maximum coefficient matrix order). Default is 3. To utilize the maximum matrix order, set to NULL.  
整数，表示最大为计算基准学生的成长百分（不论的最大系数矩阵的阶）。默认值是3。最大限度地利用矩阵的阶，设置为NULL。


参数：return.matrices.only
Boolean variable indicating whether the function will only return baseline referenced coefficient matrices. Defaults to FALSE.  
布尔变量，表示是否该函数将只返回基线参考的系数矩阵。默认为false。


参数：calculate.baseline.sgps
Boolean variable indicating whether the function will calcualte baseline referenced student growth percentiles from baseline referenced coefficient matrices. Defaults to TRUE.  
布尔变量，表示是否的的功能将calcualte基线引用的系数矩阵的基线参考学生的成长百分。默认为true。


参数：goodness.of.fit.print
Boolean variable indicating whether the function will export goodness of fit plots if baseline referenced student growth percentiles are calculated. Defaults to TRUE.  
布尔变量的功能是否将出口善良的拟合图，如果基线参考学生的成长百分计算。默认为true。


参数：...
Arguments to be passed internally to studentGrowthPercentiles for finer control over SGP calculations.  
要传递内部studentGrowthPercentiles为SGP计算更精确地控制。


值----------Value----------

If return.matrices.only is set to TRUE function returns a list containing the baseline referenced coefficient matrices. Otherwise function returns the SGP object provided with the sgp_object argument with the baseline referenced coefficient matrices, growth percentiles, etc. embedded.  
如果return.matrices.only设置为TRUE函数返回一个列表，其中包含引用的基准系数矩阵。否则，函数返回提供SGP对象，参数与参考的基准系数矩阵，增长百分等嵌入式sgp_object。


（作者）----------Author(s)----------


Adam Van Iwaarden <a href="mailto:Vaniwaarden@colorado.edu">Vaniwaarden@colorado.edu</a>, Ben Domingue <a href="mailto:ben.domingue@gmail.com">ben.domingue@gmail.com</a> and Damian W. Betebenner <a href="mailto:dbetebenner@nciea.org">dbetebenner@nciea.org</a>



参见----------See Also----------

prepareSGP, analyzeSGP, combineSGP
prepareSGP，analyzeSGP，combineSGP


实例----------Examples----------


## Not run: [＃不运行：]
##  Calculate baseline referenced SGPs (using coefficient matrices embedded in SGPstateData)[＃计算基线引用青稞（使用嵌入在SGPstateData的系数矩阵）]

Demonstration_SGP <- prepareSGP(sgpData_LONG)
Demonstration_SGP <-  baselineSGP(Demonstration_SGP)


## Calculate baseline referenced coefficient matrices[＃计算基准参考的系数矩阵]

SGPstateData[["DEMO"]][["Baseline_splineMatrix"]] <- NULL
Demonstration_SGP <- prepareSGP(sgpData_LONG)
DEMO_Baseline_Matrices <- baselineSGP(Demonstration_SGP, return.matrices.only=TRUE, calculate.baseline.sgps=FALSE)


## Calculate baseline referenced coefficient matrices and baseline referenced SGPs with 4 years of data[＃4年的数据计算基准引用系数矩阵和基线引用青稞，]

SGPstateData[["DEMO"]][["Baseline_splineMatrix"]] <- NULL

sgpData_LONG_1011 <- subset(sgpData_LONG, YEAR!="2011_2012")

Demonstration_SGP <- prepareSGP(sgpData_LONG_1011)
Demonstration_SGP <- baselineSGP(Demonstration_SGP)

## End(Not run)  [＃（不执行）]

转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。


注：
注1：为了方便大家学习，本文档为生物统计家园网机器人LoveR翻译而成，仅供个人R语言学习参考使用，生物统计家园保留版权。
注2：由于是机器人自动翻译，难免有不准确之处，使用时仔细对照中、英文内容进行反复理解，可以帮助R语言的学习。
注3：如遇到不准确之处，请在本贴的后面进行回帖，我们会逐渐进行修订。