R语言:gsummary()函数中文帮助文档(中英文对照)

loveR

gsummary(nlme)
gsummary()所属R语言包：nlme

                                        Summarize by Groups
                                         分组综述

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

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

Provide a summary of the variables in a data frame by groups of rows. This is most useful with a groupedData object to examine the variables by group.
提供了在一个行组数据框的变量的总结。这是最有用的groupedData对象，检查组变量。


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


gsummary(object, FUN, omitGroupingFactor, form, level,
   groups, invariantsOnly, ...)



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

参数：object
an object to be summarized - usually a groupedData object or a data.frame.  
概括对象 - 通常是groupedData对象或data.frame。


参数：FUN
an optional summary function or a list of summary functions to be applied to each variable in the frame.  The function or functions are applied only to variables in object that vary within the groups defined by groups.  Invariant variables are always summarized by group using the unique value that they assume within that group.  If FUN is a single function it will be applied to each non-invariant variable by group to produce the summary for that variable.  If FUN is a list of functions, the names in the list should designate classes of variables in the frame such as ordered, factor, or numeric.  The indicated function will be applied to any non-invariant variables of that class.  The default functions to be used are mean for numeric factors, and Mode for both factor and ordered.  The Mode function, defined internally in gsummary, returns the modal or most popular value of the variable.  It is different from the mode function that returns the S-language mode of the variable.  
一个可选的汇总函数或汇总函数的列表被应用到每个变量框架。函数或功能只适用于在变量object，在groups定义组不同。不变的变量总是总结组采用独特的价值，他们在该组承担。 FUN如果是一个单一的功能，将应用于组每个非不变的变量，该变量为生产总结。如果FUN是一个功能列表，列表中的名称应指定类的变量，如ordered，factor或numeric帧。指定的函数将被应用到这个类的任何非不变的变量。要使用的默认功能是mean数字因素，Mode都factor和ordered。 Mode函数内部定义在gsummary，返回变量的模式或最流行的价值。它mode函数返回变量的S-语言模式是不同的。


参数：omitGroupingFactor
an optional logical value.  When TRUE the grouping factor itself will be omitted from the group-wise summary but the levels of the grouping factor will continue to be used as the row names for the data frame that is produced by the summary. Defaults to FALSE.  
一个可选的逻辑值。当TRUE分组因素本身将组明智的总结，但被忽略的总结产生的数据框的行名，分组因素的水平，将继续使用。 FALSE默认。


参数：form
an optional one-sided formula that defines the groups. When this formula is given, the right-hand side is evaluated in object, converted to a factor if necessary, and the unique levels are used to define the groups.  Defaults to formula(object).   
可选片面的公式，定义组。当这个公式，右侧被评为object，转换到一个因素，如果必要，和独特的水平用来定义组。 formula(object)默认。


参数：level
an optional positive integer giving the level of grouping to be used in an object with multiple nested grouping levels. Defaults to the highest or innermost level of grouping.
一个可选的正整数水平分组将在多个嵌套分组级别的对象。默认分组的最高或最内层水平。


参数：groups
an optional factor that will be used to split the  rows into groups.  Defaults to getGroups(object, form, level).  
一个可选的因素将被用来分裂成组的行。 getGroups(object, form, level)默认。


参数：invariantsOnly
an optional logical value.  When TRUE only  those covariates that are invariant within each group will be summarized.  The summary value for the group is always the unique value taken on by that covariate within the group.  The columns in the summary are of the same class as the corresponding columns in object. By definition, the grouping factor itself must be an invariant.   When combined with omitGroupingFactor = TRUE, this option can be used to discover is there are invariant covariates  in the data frame.  Defaults to FALSE.  
一个可选的逻辑值。当TRUE只有那些变项，每个组内不变将总结。该组的汇总值始终是由该协集团内的独特价值。在摘要中列有相应的列在object同一类。由定义，分组因素本身必须是一个不变的。当结合使用omitGroupingFactor = TRUE，这个选项可以用来发现有不变协变量在数据框。 FALSE默认。


参数：...
optional additional arguments to the summary functions that are invoked on the variables by group.  Often it is helpful to specify na.rm = TRUE.  
摘要组变量上调用的功能，可选的附加参数。往往是很有帮助指定na.rm = TRUE。


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

A data.frame with one row for each level of the grouping factor.  The number of columns is at most the number of columns in object.
一个data.frame一排为每个分组因素的水平。列数是列object的数量最多。


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


Jose Pinheiro and Douglas Bates <a href="mailto:bates@stat.wisc.edu">bates@stat.wisc.edu</a>



参考文献----------References----------

in S and S-PLUS&quot;, Springer.  

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

summary, groupedData,
summary，groupedData


举例----------Examples----------


gsummary(Orthodont)  # default summary by Subject[由主题的默认汇总]
## gsummary with invariantsOnly = TRUE and omitGroupingFactor = TRUE[＃gsummary，与invariantsOnly = TRUE和omitGroupingFactor = TRUE]
## determines whether there are covariates like Sex that are invariant[＃确定是否有协变量，如性别是不变的]
## within the repeated observations on the same Subject.[＃内就同一主题的重复观测。]
gsummary(Orthodont, inv = TRUE, omit = TRUE)

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


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