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

loveR

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

                                        Prepare data for SGP analyses
                                         SGP准备数据分析

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

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

Utility function/exemplar used to embed supplied long data into a list object as a keyed data.table.
实用功能/模范用于提供术语数据嵌入到一个列表对象作为一个加密data.table。


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


prepareSGP(data,
        state=NULL,
        var.names=NULL,
        create.additional.variables=TRUE,
        fix.duplicates="keep.all")



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

参数：data
A panel data set in long form. See embedded sgpData_LONG data set for an exemplar.   
长形的面板数据。嵌入sgpData_LONG数据集的典范。


参数：state
A two letter acronymn indicating the state associated with the data. If not supplied, the function will try to infer what the state is from the data object name supplied.  
两个字母acronymn的表示与数据相关的状态。如果没有提供，该函数将尝试推断出什么样的状态是从数据对象中提供的名称。


参数：var.names
A list or a dataframe that includes all required columns that do not match the SGP conventions, as well as all secondary columns needed  for summarization and reporting.  
一个列表或一个数据框，其中包含所有需要的列不匹配的的SGP约定，需要总结和报告，以及所有辅助列。


参数：create.additional.variables
Boolean argument indicating whether prepareSGP should create additional variables often used in analyses. For example, the function can create a variable HIGH_NEED_STATUS identifying the top and bottom quartile of students in each school by year by content area by grade grouping.  
布尔参数，指示，是否prepareSGP创建额外的变量通常用于分析。例如，函数可以创建一个变量HIGH_NEED_STATUS确定每年每所学校的学生按年级分组的内容区域的顶部和底部的四分位数。


参数：fix.duplicates
Argument for future functionality intended to deal with duplicate cases in supplied long data.  
处理重复的情况下，提供术语数据为将来的功能参数。


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

Function returns an object of class SGP. The long data is in the data slot.
函数返回一个对象类SGP。长数据是data槽。


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


Ben Domgingue <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----------

sgpData_LONG
sgpData_LONG


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


## Not run: [＃不运行：]
## prepareSGP is Step 1 of 5 of abcSGP[＃prepareSGP的第1步5 abcSGP]
Demonstration_SGP <- prepareSGP(sgpData_LONG)

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

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


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