R包compareGroups详细用法

compareGroups

compareGroups 是一个功能强大的 R 包，专为数据质量控制、数据探索和生成用于出版的单变量或双变量表格而设计。它能够创建各种格式的报表，如纯文本、HTML、LaTeX、PDF、Word 或 Excel 格式，并显示统计数据（均值、中位数、频率、发生率等）。此外，它还能生成可视化图表（如箱线图、条形图、正态分布图等），帮助快速理解数据分布。根据变量的性质（正态、非正态或定性变量），compareGroups 可以自动选择合适的统计检验（如t检验、方差分析、Kruskal-Wallis检验、Fisher检验、log-rank检验等）。它还支持基因数据的总结与分析，显示单核苷酸多态性（SNPs）的等位基因频率，并进行哈迪-温伯格平衡检验等常见的基因统计分析。

1、cGroupsGUI--基于tcltk工具的图形用户界面

描述

该函数允许用户通过图形界面以简单直观的方式构建表格，并修改多个选项。

用法

cGroupsGUI(X) 

1. X : 一个矩阵或 data.frame。X 必须存在于 .GlobalEnv 中。

注意

如果通过 X 参数传递了 data.frame 或矩阵，或通过 '加载数据' GUI 菜单加载该对象，此对象将被放置在 .GlobalEnv 中。当 GUI 界面打开时，操作此 data.frame 或矩阵可能会导致 GUI 操作执行时出错。

示例

data(regicor)
cGroupsGUI(regicor)

2、cGroupsWUI--基于 Shiny 工具的 Web 用户界面

描述

该函数使用基于 shiny 包的图形界面，在 Web 浏览器中打开界面。

用法

cGroupsWUI(port = 8102L)  

1. port : 整数类型，与 runApp 的 port 参数相同。默认值为 8102L。如果启动 Web 浏览器时发生错误，可以通过更改端口号来解决。

示例

require(compareGroups)
cGroupsWUI()

3、compareGroups--按组描述性统计

描述

该函数执行按组的描述性统计，适用于多个变量。根据这些变量的性质，计算不同的描述性统计（均值，中位数，频率或 K-M 概率），并根据需要进行不同的统计检验（t 检验，ANOVA，Kruskal-Wallis，Fisher，log-rank 等）。

用法

compareGroups(formula, 
              data, 
              subset, 
              na.action = NULL, 
              y = NULL, 
              Xext = NULL, 
              selec = NA, 
              method = 1, 
              timemax = NA, 
              alpha = 0.05, 
              min.dis = 5, 
              max.ylev = 5, 
              max.xlev = 10, 
              include.label = TRUE, 
              Q1 = 0.25, 
              Q3 = 0.75, 
              simplify = TRUE, 
              ref = 1, 
              ref.no = NA, 
              fact.ratio = 1, 
              ref.y = 1, 
              p.corrected = TRUE, 
              compute.ratio = TRUE, 
              include.miss = FALSE, 
              oddsratio.method = "midp", 
              chisq.test.perm = FALSE, 
              byrow = FALSE, 
              chisq.test.B = 2000, 
              chisq.test.seed = NULL, 
              Date.format = "d-mon-Y", 
              var.equal = TRUE, 
              conf.level = 0.95, 
              surv=FALSE, 
              riskratio = FALSE, 
              riskratio.method = "wald", 
              compute.prop = FALSE, 
              lab.missing = "'Missing'", 
              p.trend.method = "spearman")

1. formula : 一个"公式"类的对象（或可以被转换为该类的对象）。~ 的右侧必须以加法方式包含项，左侧必须包含分组变量的名称。如果留空，则计算整个样本的描述性统计，而不进行测试。

2. data : 一个可选的数据框、列表或环境（或可以被 as.data.frame 转换为数据框的对象），包含模型中的变量。如果在 data 中找不到这些变量，则从 environment(formula) 中提取。

3. subset : 一个可选的向量，指定用于计算过程的个体子集。它应用于所有行变量。subset 和 selec 在每个行变量上以 & 的方式结合应用。

4. na.action : 一个函数，指示当数据中包含缺失值时应采取的操作。默认值为 NULL，相当于 na.pass，这意味着不采取任何操作。na.exclude 对于希望在任何变量中移除所有缺失值的情况很有用。

5. y: 一个向量变量，用于区分分组。它必须是数字、字符、因子或 NULL。默认值为 NULL，表示计算整个样本的描述性统计，而不进行测试。

6. Xext : 一个数据框或矩阵，包含与 X 相同的行/个体，但可能具有不同的变量/列。此参数用于 compareGroups.default，以便在 Xext 和/或 .GlobalEnv 中搜索在 selec 参数中指定的变量。如果 Xext 为 NULL，则从 X 加上 y 的变量创建 Xext。默认值为 NULL。

7. selec : 一个与行变量数量相同的列表。如果列表长度为 1，则对所有行变量进行回收。selec 的每个组件是一个表达式，将被评估以选择要分析的个体。否则，命名列表指定应用于 selec 行变量。如果没有定义 .else 变量，则对其余变量应用默认值。默认值为 NA；所有个体都会被分析（不进行子集）。

8. method: 一个整数向量，具有与行变量数量相同的组件。如果其长度为 1，则对所有行变量进行回收。它仅适用于连续行变量（对于因子行变量，将被忽略）。可能的值是：

   • 1：强制分析为"正态分布"；
   • 2：强制分析为"连续非正态"；
   • 3：强制分析为"分类"；
   • 4：NA，执行 Shapiro-Wilk 检验以决定正态或非正态。 否则，命名向量指定应用于 method 行变量。如果没有定义 .else 变量，则对其余变量应用默认值。默认值为 1。

9. timemax : 一个双精度向量，具有与行变量数量相同的组件。如果其长度为 1，则对所有行变量进行回收。它仅适用于 Surv 类行变量（对于所有其他行变量，将被忽略）。该值指示在何时计算 K-M 概率。否则，命名向量指定应用于 timemax 行变量。如果没有定义 .else 变量，则对其余变量应用默认值。默认值为 NA；K-M 概率在观察到的时间的中位数时计算。

10. alpha: 介于 0 和 1 之间的双精度值。Shapiro-Wilk 正态性检验的显著性阈值，适用于连续行变量。默认值为 0.05。

11. min.dis : 一个整数。如果非因子行变量包含少于 min.dis 个不同值，并且 method 参数设置为 NA，则将其转换为因子。默认值为 5。

12. max.ylev : 一个整数，表示分组变量（y）的最大水平数量。如果 y 包含超过 max.ylev 的水平，则函数 compareGroups 会产生错误。默认值为 5。

13. max.xlev : 一个整数，表示行变量作为因子时的最大水平数量。如果行变量是因子（或转换为因子，例如字符），并且包含超过 max.xlev 的水平，则会从分析中移除该变量，并打印警告。默认值为 10。

14. include.label: 逻辑值，指示结果中是否显示变量标签。默认值为 TRUE。

15. Q1: 一个双精度值，介于 0 和 1 之间，指示要在双变量表中显示的第一个数字的分位数。要计算最小值，只需输入 0。默认值为 0.25，表示第一个四分位数。

16. Q3: 一个双精度值，介于 0 和 1 之间，指示要在双变量表中显示的第二个数字的分位数。要计算最大值，只需输入 1。默认值为 0.75，表示第三个四分位数。

17. simplify: 逻辑值，指示是否在分组变量和行变量中删除没有值的水平。默认值为 TRUE。

18. ref : 一个整数向量，具有与行变量数量相同的组件。如果其长度为 1，则对所有行变量进行回收。它仅适用于分类行变量。或者，命名向量指定应用于 ref 的行变量（一个保留名称是 .else，定义其余变量的参考类别）；如果没有定义 .else 变量，则对其余变量应用默认值。默认值为 1。

19. ref.no : 一个字符，指定作为 Odds Ratio 或 Hazard Ratio 的参考水平的名称。此名称不区分大小写。特别适用于是/否变量。默认值为 NA，表示 ref 指定的类别作为参考。

20. fact.ratio : 一个双精度向量，具有与行变量数量相同的组件，指示 HR/OR 的单位（注意这不影响描述性统计）。如果其长度为 1，则对所有行变量进行回收。否则，命名向量指定应用于 fact.ratio 的行变量。.else 是一个保留名称，定义其余变量的参考类别；如果没有定义 .else 变量，则对其余变量应用默认值。默认值为 1。

21. ref.y: 一个整数，指示 y 变量的参考类别，用于计算 OR，当 y 是二元因子时。默认值为 1。

22. p.corrected: 逻辑值，指示是否必须校正成对比较的 p 值。这仅适用于具有超过 2 个类别的分组变量。默认值为 TRUE。

23. compute.ratio: 逻辑值，指示是否必须计算 Odds Ratio（对于二元响应）或 Hazard Ratio（对于时间事件响应）。默认值为 TRUE。

24. include.miss: 逻辑值，指示是否将缺失值视为分类变量的新类别。默认值为 FALSE。

25. oddsratio.method : 指定计算 Odds Ratio 的方法。参见 oddsratio 参数（来自 epitools 包）。默认值为 "midp"。

26. byrow: 逻辑值或 NA。应按行（TRUE）、列（FALSE）还是按行和列总结为 1（NA）报告分类变量的百分比。默认值为 FALSE，表示按列报告百分比（在组内）。

27. chisq.test.perm : 逻辑值。它应用排列卡方检验（chisq.test），而不是精确的 Fisher 检验（fisher.test）。这仅适用于某些单元的预期计数低于 5 的情况。

28. chisq.test.B: 整数。在计算排列卡方检验时的次数。默认值为 2000。

29. chisq.test.seed: 整数或 NULL。进行排列卡方检验的种子。默认值为 NULL，这表示不设置种子。必须输入与 NULL 不同的数字，以便在执行排列卡方检验时重现结果。

30. date.format: 字符，指示日期的显示方式。默认值为 "d-mon-Y"。有关更多信息，请参见 chron。

31. var.equal: 逻辑值，指示在比较均值时是否考虑相等方差，适用于正态分布变量的多个组。如果为 TRUE，则应用 anova 函数，否则应用 oneway.test。默认值为 TRUE。

32. conf.level: 双精度值，表示均值、中位数、比例或发生率，以及危险、赔率和风险比的置信区间的置信水平。默认值为 0.95。

33. surv: 逻辑值。计算生存（TRUE）还是发生率（FALSE），适用于时间事件行变量。默认值为 FALSE。

34. riskratio: 逻辑值。计算 Odds Ratio（FALSE）还是风险比（TRUE）。默认值为 FALSE。

35. riskratio.method : 指定计算 Odds Ratio 的方法。参见 riskratio 参数（来自 epitools 包）。默认值为 "wald"。

36. compute.prop: 逻辑值。计算比例（TRUE）还是百分比（FALSE），适用于分类行变量。默认值为 FALSE。

37. lab.missing : 字符。缺失类别的标签。仅在 include.missing = TRUE 时适用。默认值为 "Missing"。

38. p.trend.method: 字符，指示用于趋势 p 值的测试名称。它仅适用于数值非正态变量。可能的值为 "spearman"、"kendall" 或 "cuzick"。默认值为 "spearman"。

详细信息

根据行变量被视为连续正态分布（1）、连续非正态分布（2）或分类变量（3），执行以下描述性统计和检验：

1. 正态分布：计算均值、标准差，并进行 t 检验或 ANOVA。
2. 非正态分布：计算中位数、第 1 和第 3 四分位数（默认），并进行 Kruskal-Wallis 检验。
3. 分类变量：计算绝对频率和相对频率，并在某些单元格的期望频率小于 5 时进行卡方检验或精确 Fisher 检验。

此外，行变量可以是 Surv 类。此时，计算在固定时间（通过 timemax 参数设置）下的"事件"概率，并进行 logrank 检验。

当组数超过 2 时，还会执行成对比较，调整多重检验（当行变量为正态分布时使用 Tukey 方法，否则使用 Benjamini & Hochberg 方法），并计算趋势的 p 值。对于正态分布的行变量，趋势的 p 值通过 Pearson 检验计算；对于连续非正态分布的变量，使用 Spearman 检验计算趋势的 p 值。此外，对于连续非正态分布的变量，可以使用 Kendall 检验（method='kendall' 来自 cor.test）或 Cuzick 检验（cuzickTest）计算趋势的 p 值。如果行变量为 Surv 类，则从 Cox 模型中计算得分检验，其中分组变量作为整数变量预测因子引入。如果行变量为分类变量，则通过 Mantel-Haenszel 趋势检验计算趋势的 p 值。

如果有两个组，将为每个行变量计算 Odds Ratio 或 Risk Ratio。而如果响应是 Surv 类（即时间到事件），则计算 Hazard Ratios。当 x 变量为因子时，使用 epitools 包中的 oddsratio 和 riskratio 分别计算 Odds Ratio 和 Risk Ratio。当 x 变量为连续变量时，在具有典型链接和对数链接的逻辑回归下计算 Odds Ratio 和 Risk Ratio。对于 Hazard Ratios 的 p 值，在行变量为分类或连续时，分别通过 logrank 检验或 Wald 检验计算。

示例

require(compareGroups)
require(survival)

# 加载 REGICOR 数据
data(regicor)

# 计算心血管事件的时间变量
regicor$tcv <- with(regicor, Surv(tocv, as.integer(cv=='Yes')))
attr(regicor$tcv,"label")<-"Cardiovascular"

# 计算总体死亡时间变量
regicor$tdeath <- with(regicor, Surv(todeath, as.integer(death=='Yes')))
attr(regicor$tdeath,"label") <- "Mortality"

# 按性别计算描述性统计
res <- compareGroups(sex ~ .-id-tocv-cv-todeath-death, data = regicor)
summary(res)

# 单变量绘图
## plot(res)

# 性别分层的所有行变量的绘图
## plot(res, bivar = TRUE)

# 更新响应变量为心血管事件的时间
## update(res, tcv ~ . + sex- tdeath- tcv)

4、compareSNPs--按组描述遗传统计数据

描述

该函数提供了您 SNP 数据的广泛摘要范围，使您能够对基因分型结果进行深入的质量控制，并在分析之前探索数据。摘要指标包括等位基因和基因型频率及计数、缺失率、哈迪-温伯格平衡等，可以在整个数据集或按其他变量（如病例对照状态）进行分层。它还可以测试组间缺失率的差异。

用法

compareSNPs(formula, 
            data, 
            subset, 
            na.action = NULL, 
            sep = "", 
            verbose = FALSE, ...)

1. formula : 一个"公式"类对象（或可以转换为该类的对象）。~ 的右侧必须以加法方式包含项，这些项必须引用 data 中的变量，并且必须是字符或因子类，其级别是以其水平写出的基因型（例如，A/A、A/T 和 T/T）。~ 的左侧必须包含分组变量的名称，或者可以留空（在这种情况下，将为整个样本提供摘要数据，并且不进行缺失性检验）。

2. data : 一个可选的数据框、列表或环境（或可以通过 as.data.frame 转换为数据框的对象），包含模型中的变量。如果在 data 中找不到它们，则从 environment(formula) 中获取变量。

3. subset: 一个可选的向量，指定用于计算过程的个体子集（适用于所有遗传变量）。

4. na.action : 一个指示数据中包含 NAs 时应采取何种措施的函数。默认值为 NULL，相当于 na.pass，意味着不采取任何措施。na.exclude 对于希望删除任何变量中有缺失值的所有个体时可能会很有用。

5. sep : 字符串，指示等位基因之间的分隔符（例如，当使用 A/A、A/T 和 T/T 基因型编码时，sep 应设置为 /。默认值为 ""，表示基因型编码为 AA、AT 和 TT。

6. verbose: 逻辑值，打印 HWChisq 函数的结果。默认值为 FALSE。

7. ...: 目前被忽略的参数。

示例

require(compareGroups)

# load example data
data(SNPs)

# visualize first rows
head(SNPs)

# select casco and all SNPs
myDat <- SNPs[,c(2,6:40)]

# QC of three SNPs by groups of cases and controls
res<-compareSNPs(casco ~ .-casco, myDat)
res

# QC of three SNPs of the whole data set
res<-compareSNPs( ~ .-casco, myDat)
res

5、createTable--分组描述表:二元表

描述

这个函数用分组的描述构建一个"紧凑"和"漂亮"的表。

用法

createTable(x, 
            hide = NA, 
            digits = NA, 
            type = NA, 
            show.p.overall = TRUE,
            show.all, 
            show.p.trend, 
            show.p.mul = FALSE, 
            show.n, 
            show.ratio =FALSE, 
            show.descr = TRUE, 
            show.ci = FALSE, 
            hide.no = NA, 
            digits.ratio = NA,
            show.p.ratio = show.ratio, 
            digits.p = 3, 
            sd.type = 1, 
            q.type = c(1, 1),
            extra.labels = NA, 
            all.last = FALSE, 
            lab.ref = "Ref.", 
            stars = FALSE)

参数

1. x: 一个 "compareGroups" 类对象。

2. hide: 一个向量（或列表），包含与行变量数量相同的整数或字符。如果其长度为 1，则对所有行变量进行回收。每个组件指定必须隐藏且不显示的类别（如果是字符，则为类别的文字名称；如果是整数，则为位置）。此参数仅适用于分类行变量，对于连续行变量将被忽略。如果为 NA，则显示所有类别。或者是一个命名向量（或命名列表），指定应用于哪些行变量的 'hide'，其余行变量应用默认值。默认值为 NA。

3. digits: 一个整数向量，其组件数量与行变量相同。如果其长度为 1，则对所有行变量进行回收。每个组件指定要显示的有效小数位数。或者是一个命名向量，指定 'digits' 应用于哪些行变量（一个保留名称是 '.else'，定义其余变量的 'digits'）；如果没有定义 '.else' 变量，则对其余变量应用默认值。默认值为 NA，表示使用"适当"的小数位数（详细信息请参见说明文档）。

4. type: 一个整数，指示是否显示绝对和/或相对频率：1 - 仅相对频率；2 或 NA - 绝对和相对频率（以括号显示）；3 - 仅绝对频率。

5. show.p.overall: 逻辑值，指示是否显示整体组显著性（'p.overall' 列）的 p 值。默认值为 TRUE。

6. show.all: 逻辑值，指示是否显示 '[ALL]' 列（未按组分层的所有数据）。如果定义了分组变量，则默认值为 FALSE；如果没有组，则为 FALSE。

7. show.p.trend: 逻辑值，指示是否显示 p-trend。如果组少于 3，则始终为 FALSE。如果缺少此参数且组数超过 2 且分组变量为有序因子，则显示 p-trend。默认情况下，p-trend 不显示；当组数超过 2 且分组变量为有序因子类时显示。

8. show.p.mul: 逻辑值，指示是否显示成对（组间）比较的 p 值。组数少于 3 时始终为 FALSE。默认值为 FALSE。

9. show.n: 逻辑值，指示是否在 'descr' 表中显示每个行变量分析的个体数量。默认值为 FALSE，当没有组时为 TRUE。

10. show.ratio: 逻辑值，指示是否显示 OR / HR。默认值为 FALSE。

11. show.descr: 逻辑值，指示是否显示描述性统计（即均值、比例等）。默认值为 TRUE。

12. show.ci: 逻辑值，指示是否显示均值、中位数、比例或发生率的置信区间。如果是，则显示在方括号之间。默认值为 FALSE。

13. hide.no: 字符，指定要隐藏的名称级别，适用于所有具有 2 个类别的分类变量。大小写不敏感。结果是该变量只显示名称而不显示类别。这对是/否变量尤其有用。对于 'hide' 参数不同于 NA 的分类行变量将被忽略。默认值为 NA，表示不隐藏任何类别。

14. digits.ratio: 与 'digits' 参数相同，但适用于风险比或赔率比。

15. show.p.ratio: 逻辑值，指示是否显示与每个风险比/赔率比对应的 p 值。

16. digits.p: 整数，指示所有 p 值显示的小数位数。默认值为 3。

17. sd.type: 一个整数，指示标准偏差的显示方式：1 - 均值（SD），2 - 均值 ± SD。

18. q.type: 一个包含两个整数的向量。第一个组件指非正态行变量显示的括号类型（1 - 方形，2 - 圆形），第二个组件指百分位数分隔符（1 - ';'，2 - '，'，3 - '-'）。默认值为 c(1, 1)。

19. extra.labels: 字符向量，包含 4 个组件，对应于附加到正常、非正态、分类或生存行变量标签的关键标签。默认值为 NA，不附加任何额外关键字。如果设置为 c("","","","")，则附加"Mean (SD)"、"Median [25th; 75th]"、"N (%)" 和 "Incidence at time=timemax"（请参阅 compareGroups 函数中的 timemax 参数）。

20. all.last: 逻辑值。整个样本的描述性统计放在按组描述性统计之后。默认值为 FALSE，表示整体队列的描述性统计放在第一位。

21. lab.ref: 字符。参考类别的显示字符串。默认值为 "Ref."。

22. stars: 逻辑值，指示是否在 p 值旁边附加星号；'**'：p 值 < 0.05，'*' 0.05 <= p 值 < 0.1；"" p 值 >= 0.1。默认值为 FALSE。

23. which.table: 字符，指示打印哪个表。可能的值为 'descr'、'avail' 或 'both'（允许部分匹配），分别打印按组描述性统计表、可用数据表或两个表。默认值为 'descr'。

24. nmax: 逻辑值，指示是否显示所有行变量中至少具有一个有效值的主题数量。默认值为 TRUE。

25. nmax.method: 整数，有两个可能的值：1 - 在至少一个行变量中具有有效值的观察数量；2 - 数据集或组中的总观察数量或行数。默认值为 1。

26. header.labels: 一个命名字符向量，包含 'all'、'p.overall'、'p.trend'、'ratio'、'p.ratio' 和 'N' 组件，指示 '[ALL]'、'p.overall'、'p.trend'、'ratio'、'p.ratio' 和 'N'（可用数据）的标签。默认值为零长度向量，不做更改，即 '[ALL]'、'p.overall'、'p.trend'、'ratio'、'p.ratio' 和 'N' 标签显示在整个队列的描述性统计、全局 p 值、趋势的 p 值、HR/OR 和每个 HR/OR 的 p 值以及可用数据中。

27. ...: 传递给 print.default 的其他参数。

示例

# 加载所需的包
require(compareGroups)
require(survival)

# 加载 REGICOR 数据
data(regicor)

# 计算心血管事件的时间变量
regicor$tcv <- with(regicor, Surv(tocv, as.integer(cv == 'Yes')))
attr(regicor$tcv, "label") <- "Cardiovascular incidence"

# 根据心血管事件的时间计算描述性统计，以 'no' 类别作为参考来计算 HR。
res <- compareGroups(tcv ~ age + sex + smoker + sbp + histhtn + chol + txchol + bmi + phyact + pcs + tcv, regicor, ref.no = 'no')

# 构建显示 HR 的表格，并隐藏 'no' 类别
restab <- createTable(res, show.ratio = TRUE, hide.no = 'no')
restab  # 打印可用信息表

# 进行总结
summary(restab)  # 更多...

## 不运行的代码：
# 添加 '可用数据' 列
update(restab, show.n = TRUE)

# 整个队列的描述性统计
update(restab, x = update(res, ~ .))

# 将响应变量更改为性别
# 显示比值比（OR）而不是风险比（HR）。
# 请注意，现在可以计算按死亡时间或心血管事件时间的描述性统计，但不能计算 OR。
# 将 timemax 设置为 5 年，以报告 5 年的死亡概率和心血管事件概率：
update(restab, x = update(res, sex ~ . - sex + tdeath + tcv, timemax = 5 * 365.25))

## 组合表格：
# a) 按行：将前四个变量作为一组，其余变量作为另一组：
rbind("First group of variables" = restab[1:4], "Second group of variables" = restab[5:length(res)])

# b) 按列：将按性别分层的表格并排放置：
res1 <- compareGroups(year ~ . - id - sex, regicor)
restab1 <- createTable(res1, hide.no = 'no')
restab2 <- update(restab1, x = update(res1, subset = sex == 'Male'))

6、createTable--执行描述并构建二元表

描述

这个函数一步构建一个双变量表，调用compareGroups和createTable函数。

用法

descrTable(formula,
          data,
          subset,
          na.action = NULL,
          y = NULL,
          Xext = NULL,
          selec = NA,
          method = 1,
          timemax = NA,
          alpha = 0.05,
          min.dis = 5,
          max.ylev = 5,
          max.xlev = 10,
          include.label = TRUE,
          Q1 = 0.25,
          Q3 = 0.75,
          simplify = TRUE,
          ref = 1,
          ref.no = NA,
          fact.ratio = 1,
          ref.y = 1,
          p.corrected = TRUE,
          compute.ratio = TRUE,
          include.miss = FALSE,
          oddsratio.method = "midp",
          chisq.test.perm = FALSE,
          byrow = FALSE,
          chisq.test.B = 2000,
          chisq.test.seed = NULL,
          Date.format = "d-mon-Y",
          var.equal = TRUE,
          conf.level = 0.95,
          surv = FALSE,
          riskratio = FALSE,
          riskratio.method = "wald",
          compute.prop = FALSE,
          lab.missing = "'Missing'",
          p.trend.method = "spearman",
          hide = NA,
          digits = NA,
          type = NA,
          show.p.overall = TRUE,
          show.all,
          show.p.trend,
          show.p.mul = FALSE,
          show.n,
          show.ratio = FALSE,
          show.descr = TRUE,
          show.ci = FALSE,
          hide.no = NA,
          digits.ratio = NA,
          show.p.ratio = show.ratio,
          digits.p = 3,
          sd.type = 1,
          q.type = c(1, 1),
          extra.labels = NA,
          all.last = FALSE,
          lab.ref = "Ref.",
          stars = FALSE
)

1. ...: 参数均同 compareGroups 和 createTabel。

示例

require(compareGroups) 

# load REGICOR data 
data(regicor) 

# perform descriptives by year and build the table. 
# note the use of arguments from compareGroups (formula and data set) and
# arguments from createTable (hide.no and show.p.mul) 
descrTable(year ~ ., regicor, hide.no="no", show.p.mul=TRUE)

7、export2csv--将描述表导出为纯文本(CSV)格式

描述

该函数接受createTable的结果，并将表导出为纯文本(CSV)格式。

用法

export2csv(x, 
           file, 
           which.table="descr", 
           sep=",", 
           nmax = TRUE, 
           nmax.method = 1, 
           header.labels = c(), 
           ...)

1. x: 一个 'createTable' 类的对象。

2. file: 将以 CSV 格式写入的文件。此外，还会写入一个扩展名为 '_appendix' 的文件，其中包含可用数据表。

3. which.table: 字符，指示打印哪个表。可能的值为 'descr'、'avail' 或 'both'（允许部分匹配），分别导出按组的描述性统计表、可用数据表或两个表。默认值为 'descr'。

4. sep : 字符。变量分隔符，与 write.table 的 sep 参数相同。默认值为 ','。

5. nmax: 逻辑值，指示是否显示在所有行变量中至少有一个有效值的受试者数量。默认值为 TRUE。

6. nmax.method: 整数，具有两个可能的值：1- 在至少一个行变量中具有有效值的观察数量；2- 数据集或组中的观察总数或行数。默认值为 1。

7. header.labels : 参见 createTable 的 header.labels 参数。

8. ... : 其他传递给 write.table 的参数。

示例

require(compareGroups) 
data(regicor) 
res <- compareGroups(sex ~.-id-todeath-death-tocv-cv, regicor) 
export2csv(createTable(res, hide.no = 'n'), file=tempfile(fileext=".csv"))

8、export2html--导出描述表为HTML格式

描述

该函数接受createTable的结果，并将表导出为HTML格式。

用法

export2html(x, 
            file, 
            which.table="descr", 
            nmax = TRUE, 
            nmax.method = 1, 
            header.labels = c(), 
            ...)

1. x: 一个 'createTable' 类的对象。

2. file: 将以 HTML 格式写入的文件。此外，还会写入一个扩展名为 '_appendix' 的文件，其中包含可用数据表。如果缺失，将返回 HTML 代码。

3. which.table: 字符，指示打印哪个表。可能的值为 'descr'、'avail' 或 'both'（允许部分匹配），分别导出按组的描述性统计表、可用数据表或两个表。默认值为 'descr'。

4. nmax: 逻辑值，指示是否显示在所有行变量中至少有一个有效值的受试者数量。默认值为 TRUE。

5. nmax.method: 整数，具有两个可能的值：1- 在至少一个行变量中具有有效值的观察数量；2- 数据集或组中的观察总数或行数。默认值为 1。

6. header.labels : 参见 createTable 的 header.labels 参数。

7. ...: 当前被忽略的其他参数。

示例

require(compareGroups) 
data(regicor) 
res <- compareGroups(sex ~.-id-todeath-death-tocv-cv, regicor) 
export2html(createTable(res, hide.no = 'n'), file=tempfile(fileext=".html"))

9、export2latex--导出描述表为LaTeX格式

描述

这个函数接受createTable的结果，并将表导出为LaTeX格式。

用法

export2latex(x, ...) 
## S3 method for class 'createTable' 
export2latex(x, f
             ile, 
             which.table = 'descr', 
             size = 'same', 
             nmax = TRUE, 
             nmax.method = 1, 
             header.labels = c(), 
             caption = NULL, 
             loc.caption = 'top', 
             label = NULL, 
             landscape = NA, 
             colmax = 10, ...) 
## S3 method for class 'cbind.createTable' 
export2latex(x, 
             file, 
             which.table = 'descr', 
             size = 'same', 
             nmax = TRUE, 
             nmax.method = 1, 
             header.labels = c(), 
             caption = NULL, 
             loc.caption = 'top', 
             label = NULL, 
             landscape = NA, 
             colmax = 10, 
             ...)

1. x: 一个 'createTable' 类的对象。

2. file: 要保存结果代码的文件名称。如果文件缺失，则输出将在屏幕上显示。此外，还会写入一个扩展名为 '_appendix' 的文件，其中包含可用数据表。

3. which.table: 字符，指示导出哪个表。可能的值为 'descr'、'avail' 或 'both'（允许部分匹配），分别导出按组的描述性统计表、可用数据表或两个表。默认值为 'descr'。

4. size: 字符，指示表元素的大小。可能的值有：'tiny'、'scriptsize'、'footnotesize'、'small'、'normalsize'、'large'、'Large'、'LARGE'、'huge'、'Huge' 或 'same'（允许部分匹配）。默认值为 'same'，表示表的字体大小与主 LaTeX 文档中指定的相同。

5. nmax: 逻辑值，指示是否显示在所有行变量中至少有一个有效值的受试者数量。默认值为 TRUE。

6. nmax.method: 整数，具有两个可能的值：1- 在至少一个行变量中具有有效值的观察数量；2- 数据集或组中的观察总数或行数。默认值为 1。

7. header.labels : 参见 createTable 的 header.labels 参数。

8. caption : 字符，指定描述性统计和可用数据表的标题。如果 which.table='both'，则 caption 的第一个元素将分配给描述性表，第二个元素分配给可用数据表。如果设置为 ""，则不插入标题。默认值为 NULL，将为描述性表写入 'Summary descriptives table by groups of 'y'，为可用数据表写入 'Available data by groups of 'y'。

9. label : 字符，指定描述性统计和可用数据表的标签。这在 LaTeX 文档的其他地方引用表格时可能很有用。如果 which.table='both'，则 label 的第一个元素将分配给描述性表，第二个元素分配给可用数据表。默认值为 NULL，不会为表格分配标签。

10. loc.caption: 字符，指定表格标题的位置。可能的值为 'top' 或 'bottom'（允许部分匹配）。默认值为 'top'。

11. landscape: 逻辑值，指示表格是否应放置为横向，或者 NA，当列数超过 'colmax' 时将表格放置为横向。默认值为 NA。

12. colmax: 整数，指示最大列数，以便表格不放置为横向。此参数仅在 'landscape' 参数为 NA 时适用。默认值为 10。

13. ...: 当前被忽略的其他参数。

示例

require(compareGroups) 
data(regicor) 
res <- compareGroups(sex ~.-id-todeath-death-tocv-cv, regicor) 
export2latex(createTable(res, hide.no = 'n'), file=tempfile(fileext=".tex"))

10、export2md--导出描述表为Markdown格式

描述

该函数接受createTable的结果，并将表导出为markdown格式。当在Markdown文件(. rmd)中插入R代码块时，它可能很有用。

用法

export2md(x, 
          which.table = "descr", 
          nmax = TRUE, 
          nmax.method = 1, 
          header.labels = c(), 
          caption = NULL, 
          format = "html", 
          width = Inf, 
          strip = FALSE, 
          first.strip = FALSE, 
          background = "#D2D2D2", 
          size = NULL, 
          landscape=FALSE, 
          header.background=NULL, 
          header.color=NULL, 
          position="center", 
          ...)

1. x: 一个 'createTable' 类的对象。

2. which.table: 字符，指示打印哪个表。可能的值为 'descr' 或 'avail'（允许部分匹配），分别导出按组的描述性统计表或可用数据表。默认值为 'descr'。

3. nmax: 逻辑值，指示是否显示在所有行变量中至少有一个有效值的受试者数量。默认值为 TRUE。

4. nmax.method: 整数，具有两个可能的值：1- 在至少一个行变量中具有有效值的观察数量；2- 数据集或组中的观察总数或行数。默认值为 1。

5. header.labels : 参见 createTable 的 header.labels 参数。

6. caption : 字符，指定描述性统计和可用数据表的标题。如果 which.table='both'，则 caption 的第一个元素将分配给描述性表，第二个元素分配给可用数据表。如果设置为 ""，则不插入标题。默认值为 NULL，将为描述性表写入 'Summary descriptives table by groups of 'y'，为可用数据表写入 'Available data by groups of 'y'。

7. export2md: 字符，具有三个选项：'html'、'latex' 或 'markdown'。如果缺失，它会尝试猜测插入表的 Rmarkdown 文件的默认选项，或者如果不在 Rmarkdown 文件中或格式未指定，则为 html。

8. width: 字符串，指定描述性表第一列的宽度。导出到 Word 时会被忽略。默认值为 Inf，这使得第一列自动调整为变量名称。其他示例有 '10cm'、'3in' 或 '30em'。

9. strip: 逻辑值。它阴影每个变量对应的表线。

10. first.strip : 逻辑值。它确定是阴影第一个变量（TRUE）还是第二个变量（FALSE）。它仅在 strip 参数为 true 时适用。

11. background: 颜色代码，以 HEX 格式表示阴影线的颜色。您可以使用 rgb 函数将红色、绿色和蓝色转换为 HEX 代码。默认颜色为 '#D2D2D2'。

12. size: 数字。描述性表的大小。默认值为 NULL，这会创建默认大小的表。

13. landscape: 逻辑值。它确定是否将表格放置为横向（水平）格式。它仅在格式为 'latex' 时适用。默认值为 FALSE。

14. header.background: 字符，用于表头的颜色或 'NULL'。默认值为 'NULL'。

15. header.color: 表头文本的颜色。默认颜色为 'NULL'。

16. position : 字符，指定表格位置。可能的值为 'left'、'center'、'right'、'float_left' 和 'float_right'。它仅在编译为 HTML 或 PDF 时适用。默认值为 'center'。有关更多信息，请参见 kable_styling 的 position 参数。

17. ...: 传递给 kable 的其他参数。

示例

---
title: "Report"
output: 
  html_document: default
---
```{r setup, include=FALSE} 
knitr::opts_chunk$set(echo = FALSE, warning=FALSE, message=FALSE) 
```

```{r} 
library(compareGroups) 
data(regicor) 
res <- compareGroups(year~., regicor) 
restab <- createTable(res) 
```
## Report section 
The following table contains descriptives of **REGICOR** data 

```{r} 
export2md(restab, strip = TRUE, first.strip = TRUE) 
```

11、export2pdf--将表格导出为PDF文件

描述

这个函数会自动创建一个带有表格的PDF。另外，LaTeX代码存储在指定的文件中。

用法

export2pdf(x, 
           file, 
           which.table="descr", 
           nmax=TRUE, 
           header.labels=c(), 
           caption=NULL, 
           width=Inf, 
           strip=FALSE, 
           first.strip=FALSE, 
           background="#D2D2D2", 
           size=NULL, 
           landscape=FALSE, 
           numcompiled=2, 
           header.background=NULL, 
           header.color=NULL)

1. x: 一个 'createTable' 类的对象或其子类。

2. file: 字符，指定编译 LaTeX 代码后生成的 PDF 文件。相应的 LaTeX 代码也会保存在同一文件夹中，并以 .tex 扩展名存储。当 'compile' 参数为 FALSE 时，仅保存 .tex 文件。

3. which.table: 字符，指示打印哪个表。可能的值为 'descr'、'avail' 或 'both'（允许部分匹配），分别打印按组的描述性统计表、可用数据表或两个表。默认值为 'descr'。

4. nmax: 逻辑，指示是否显示至少在一个行变量中具有有效值的受试者数量。默认值为 TRUE。

5. header.labels: 一个字符命名向量，包含 'all'、'p.overall'、'p.trend'、'ratio'、'p.ratio' 和 'N' 组件，指示标签分别为 '[ALL]'、'p.overall'、'p.trend'、'ratio'、'p.ratio' 和 'N'（可用数据）。默认值为零长度向量，这意味着不做任何更改。

6. caption: 字符，指定描述性和可用数据表的标题。如果 which.table='both'，则 'caption' 的第一个元素将分配给描述性表，第二个元素分配给可用数据表。如果设置为 ""，则不插入标题。默认值为 NULL。

7. width: 字符串，指定描述性表第一列的宽度。默认值为 Inf，意味着第一列自动调整到变量名称。其他示例包括 '10cm'、'3in' 或 '30em'。

8. strip: 逻辑。它影藏每个变量对应的表格线。

9. first.strip: 逻辑。它确定是否影藏第一个变量（TRUE）或第二个变量（FALSE）。仅在 strip 参数为真时适用。

10. background: HEX 格式的颜色代码，用于阴影线。默认颜色为 '#D2D2D2'。

11. size: 数字。描述性表的大小。默认值为 NULL，表示以默认大小创建表。

12. landscape: 逻辑。它决定是否以横向格式放置表格。仅在格式为 'latex' 时适用。默认值为 FALSE。

13. numcompiled: 整数。LaTeX 代码编译的次数。默认编译两次。

14. header.background: 表头的颜色字符或 'NULL'。默认值为 'NULL'。

15. header.color: 表头文本的颜色字符。默认颜色为 'NULL'。

示例

require(compareGroups)
data(regicor)
# example on an ordinary table
res <- createTable(compareGroups(year ~ . -id, regicor), hide = c(sex=1), hide.no = 'no')
export2pdf(res, file=tempfile(fileext=".pdf"), size="small")

12、export2word--将表格导出为WORD文件

描述

这个函数用表格自动创建一个Word文件。

用法

export2word(x, 
            file, 
            which.table="descr", 
            nmax=TRUE, 
            header.labels=c(),
            caption=NULL, 
            strip=FALSE, 
            first.strip=FALSE, 
            background="#D2D2D2",
            size=NULL, 
            header.background=NULL, 
            header.color=NULL)

1. x: 一个 'createTable' 类的对象或其子类。

2. file: 字符，指定编译相应的 Markdown 代码后生成的 Word 文件 (.doc 或 .docx)。

3. which.table: 字符，指示打印哪个表。可能的值为 'descr' 或 'avail'（允许部分匹配），分别导出按组的描述性统计表或可用数据表。默认值为 'descr'。

4. nmax: 逻辑，指示是否显示至少在一个行变量中具有有效值的受试者数量。默认值为 TRUE。

5. header.labels: 参见 'createTable' 的 'header.labels' 参数。

6. caption: 字符，指定描述性和可用数据表的标题。如果 which.table='both'，则 'caption' 的第一个元素将分配给描述性表，第二个元素分配给可用数据表。如果设置为 ""，则不插入标题。默认值为 NULL。

7. strip: 逻辑。它影藏每个变量对应的表格线。

8. first.strip: 逻辑。它确定是否影藏第一个变量（TRUE）或第二个变量（FALSE）。仅在 strip 参数为真时适用。

9. background: HEX 格式的颜色代码，用于阴影线。默认颜色为 '#D2D2D2'。

10. size: 数字。描述性表的大小。默认值为 NULL，表示以默认大小创建表。

11. header.background: 表头的颜色字符或 'NULL'。默认值为 'NULL'。

12. header.color: 表头文本的颜色字符。默认颜色为 'NULL'。

示例

require(compareGroups)
data(regicor)

# example on an ordinary table
res <- createTable(compareGroups(year ~ . -id, regicor), hide = c(sex=1), hide.no = 'no')
export2word(res, file = tempfile(fileext=".docx"))

13、export2xls--将描述表导出为excel格式(.xlsx或.xls)

描述

该函数接受createTable的结果，并将表导出为Excel格式(.xlsx或.xls)。

用法

export2xls(x, 
           file, 
           which.table="descr", 
           nmax=TRUE, 
           nmax.method=1, 
           header.labels=c())

1. x: 一个 'createTable' 类的对象。

2. file: 文件，指定将以 Excel 格式写入的表格。

3. which.table: 字符，指示打印哪个表。可能的值为 'descr'、'avail' 或 'both'（允许部分匹配），分别导出按组的描述性统计表、可用数据表或两个表格。在后者的情况下（'both'），将生成两个工作表，每个表对应一个。默认值为 'descr'。

4. nmax: 逻辑，指示是否显示至少在一个行变量中具有有效值的受试者数量。默认值为 TRUE。

5. nmax.method: 整数，有两个可能的值：1-表示在至少一个行变量中具有有效值的观察数量；2-数据集或组中的观察总数或行数。默认值为 1。

6. header.labels: 参见 'createTable' 的 'header.labels' 参数。

示例

require(compareGroups)
data(regicor)
res <- compareGroups(sex ~. -id-todeath-death-tocv-cv, regicor)
export2xls(createTable(res, hide.no = 'n'), file=tempfile(fileext=".xlsx"))

14、getResults--轻松检索作为r对象(矩阵和向量)的汇总数据

描述

这个函数从一个compareGroups对象中提取特定的结果(描述、p值、比值/风险比等)作为矩阵或向量。

用法

getResults(obj, what = "descr")

1. obj: 一个 'compareGroups' 或 'createTable' 类的对象。

2. what: 字符，指示要检索的结果类型：描述性统计、p 值、趋势 p 值、成对 p 值，或比值比/风险比。可能的值为："descr"、"p.overall"、"p.trend"、"p.mul" 和 "ratio"。默认值为 "descr"。

• what = "descr": 一个数组或矩阵，列数等于变量/类别数量，七列对应所有可能的描述性统计（均值、标准差、中位数、Q1、Q3、绝对和相对频率）。当分析不同组时，数组的第三维对应组；否则，结果将是没有第三维的矩阵。

• what = "p.overall": 一个向量，其元素为每个分析变量的 p 值。

• what = "p.trend": 一个向量，其元素为每个分析变量的趋势 p 值。

• what = "p.mul": 一个矩阵，包含成对 p 值，行对应分析变量，列对应每对组。

• what = "ratio": 一个矩阵，行数等于变量/类别数量，四列对应比值比/风险比、置信区间和 p 值。

示例

require(compareGroups)
data(regicor)
res<-compareGroups(sex ~ . ,regicor,method=c(triglyc=2))
# retrieve descriptives
getResults(res)
# retrieve OR and their corresponding p-values
getResults(res,what="ratio")

15、missingTable--失踪者分组统计表

描述

该函数返回一个表，其中包含已构建的二元表中不可用的频率。

用法

missingTable(obj,...)

1. obj: 一个 'compareGroups' 或 'createTable' 类的对象。

2. ...: 传递给 createTable 的其它参数。

示例

require(compareGroups)
# load regicor data
data(regicor)
# table of descriptives by recruitment year
res <- compareGroups(year ~ age + sex + smoker + sbp + histhtn +
chol + txchol + bmi + phyact + pcs + death, regicor)
restab <- createTable(res, hide.no = "no")
# missingness table
missingTable(restab,type=1)
## Not run:
# also create the missing table from a compareGroups object
miss <- missingTable(res)
miss
# some methods that works for createTable objects also works for objects
# computed by missTable function.
miss[1:4]
varinfo(miss)
plot(miss)
#... but update methods cannot be applied (this returns an error).
update(miss,type=2)
## End(Not run)

16、padjustCompareGroups--根据多次比较更新p值

描述

给定一个compareGroups对象，返回使用以下方法之一调整的p值(stats::p.adjust)

用法

padjustCompareGroups(object_compare, 
                     p = "p.overall", 
                     method = "BH")

1. object_compare: 一个 'compareGroups' 类的对象。

2. p: 字符串，指定需要校正的 p 值。可能的值为 'p.overall' 和 'p.trend'（默认值为 'p.overall'）。

3. method : 校正方法，字符串。可以使用简写形式（参见 p.adjust 函数）。

示例

# Define simulated data
set.seed(123)
N_obs<-100
N_vars<-50
data<-matrix(rnorm(N_obs*N_vars), N_obs, N_vars)
sim_data<-data.frame(data,Y=rbinom(N_obs,1,0.5))

# Execute compareGroups
res<-compareGroups(Y~.,data=sim_data)
res

# update p values
res_adjusted<-padjustCompareGroups(res)
res_adjusted

# update p values using FDR method
res_adjusted<-padjustCompareGroups(res, method ="fdr")
res_adjusted

17、printTable--"漂亮的"表格

描述

这个函数以"nice"格式在控制台上打印一个表。

用法

printTable(obj, row.names = TRUE, justify = 'right')

1. obj: 一个 'data.frame' 或 'matrix' 类的对象。它必须至少包含两列，第一列被视为 'row.names' 并且左对齐（如果 'row.names' 参数设置为 TRUE），而其余列右对齐。

2. row.names: 逻辑值，指示第一列或变量是否作为 'row.names' 列处理并且必须左对齐。默认值为 TRUE。

3. justify : 字符串，类似于 format 函数的 'justify' 参数。当 'row.names' 参数为 FALSE 时，应用于整个数据框或矩阵的所有列；否则，应用于除第一列之外的所有列。默认值为 'right'。

示例

require(compareGroups)
data(regicor)

# example of the coefficients table from a linear regression
model <- lm(chol ~ age + sex + bmi, regicor)
results <- coef(summary(model))
results <- cbind(Var = rownames(results), round(results, 4))
printTable(results)

# or visualize the first rows of the iris data frame.
# In this example, the first column is not treated as a row.names column and it is right justified.
printTable(head(iris), FALSE)

# the same example with columns centered
printTable(head(iris), FALSE, 'centre')

18、radiograph--列出数据集中的值

描述

此函数创建数据集中原始数据的报告。对于每个变量，一个唯一条目的有序列表(作为字符串读取)，用于检查输入错误。

用法

radiograph(file, 
           header = TRUE, 
           save=FALSE, 
           out.file="", ...)

1. file: 字符串，指定数据集所在的文件。

2. header : 参见 read.table 的 header 参数。

3. save: 逻辑值，指示输出是应存储在文件中 (TRUE) 还是打印在控制台上 (FALSE)。默认值为 FALSE。

4. out.file : 字符串，指定结果要输出的文件。仅当 save 参数设置为 TRUE 时适用。

5. ... : 传递给 read.table 的其他参数。

示例

## Not run:
require(compareGroups)
# read example data of regicor in plain text format with variables separated by '\t'.
datafile <- system.file("exdata/regicor.txt", package="compareGroups")
radiograph(datafile)
## End(Not run)

19、regicor--REGICOR横断面数据

描述

这些数据来自西班牙西北部赫罗纳省REGICOR研究中对具有代表性的个人进行的3次不同的横断面调查。

用法

data(regicor)

20、report--描述性表格和图的报告

描述

该函数自动创建一个PDF，其中包含描述性表以及可用性数据和所有图。该文件的结构和索引方式使用户可以浏览文档中的所有表格和图形。

用法

report(x, 
       file, 
       fig.folder, 
       compile = TRUE, 
       openfile = FALSE, 
       title = "Report",
       author, 
       date, 
       perc=FALSE, ...)

1. x: 一个 'createTable' 类的对象。

2. file : 字符串，指定在编译 LaTeX 代码后生成的 PDF 文件。LaTeX 代码也存储在同一文件夹中，扩展名为 .tex。如果 compile 参数为 FALSE，仅保存 .tex 文件。

3. fig.folder : 字符串，指定放置表格中所有行变量对应的图形的文件夹。如果省略，将在 file 文件的相同文件夹中创建一个名为 file_figures 的文件夹。

4. compile : 逻辑值，指示是否使用 texi2pdf 函数编译 .tex 文件。默认值为 TRUE。

5. openfile: 逻辑值，指示是否打开已编译的 PDF 文件。目前已弃用，默认值为 FALSE。

6. title: 字符串，指定封面上的报告标题。默认值为 "Report"。

7. author: 字符串，指定封面上的作者姓名。当省略时，封面上不显示作者姓名。

8. date: 字符串，指定封面上的报告日期。当省略时，显示当前日期。

9. perc: 逻辑值，指示是否在条形图中为分类变量显示相对频率（百分比）而不是绝对频率。

10. ... : 传递给 export2latex 的其他参数。

示例

## Not run:
require(compareGroups)
data(regicor)
# example on an ordinary table
res <- createTable(compareGroups(year ~ . -id, regicor), hide = c(sex=1), hide.no = 'no')
report(res, "report.pdf" ,size="small", title="\Huge \textbf{REGICOR study}",
        author="Isaac Subirana \\ IMIM-Parc de Salut Mar")
# example on an stratified table by sex
res.men <- createTable(compareGroups(year ~ . -id-sex, regicor, subset=sex=='Male'),
hide.no = 'no')
res.wom <- createTable(compareGroups(year ~ . -id-sex, regicor, subset=sex=='Female'),
hide.no = 'no')
res <- cbind("Men"=res.men, "Wom"=res.wom)
report(res[[1]], "reportmen.pdf", size="small",
title="\Huge \textbf{REGICOR study \\ Men}", date="") # report for men / no date
report(res[[2]], "reportwom.pdf", size="small",
title="\Huge \textbf{REGICOR study \\ Women}", date="") # report for wom / no date
## End(Not run)

20、SNPs--病例对照研究中的snp

描述

snp数据框架包含病例对照研究中选定的snp和其他病例和对照的临床协变量。

snp .info.pos data.frame包含数据集"snp"中包含的snp的名称，包括它们的染色体和它们的基因组位置。

用法

data(SNPs)

21、strataTable--分层描述表

描述

该函数在由变量定义的层中重新构建描述性表。

用法

strataTable(x, 
            strata, 
            strata.names = NULL, 
            max.nlevels = 5)

1. x: 一个 'createTable' 类的对象。

2. strata: 字符串，指定定义分层的变量名称或该变量的值/水平。

3. strata.names: 字符向量，包含与分层变量相关的名称。如果设置为 NULL（默认值），将使用分层变量水平的名称。

4. max.nlevels: 整数，指定分层变量的最大唯一值或水平数。默认值为 5。

示例

require(compareGroups)
# load REGICOR data
data(regicor)
# compute the descriptive tables (by year)
restab <- descrTable(year ~ . - id - sex, regicor, hide.no="no")
# re-build the table stratifying by gender
strataTable(restab, "sex")

22、varinfo--提取变量名和标签

描述

该函数构建并打印一个包含变量名及其标签的表。

用法

varinfo(x, ...)
## S3 method for class 'compareGroups'
varinfo(x, ...)
## S3 method for class 'createTable'
varinfo(x, ...)

1. x: 一个 'compareGroups' 或 'createTable' 类的对象。

2. ...: 其他当前被忽略的参数。

示例

require(compareGroups)
data(regicor)
res<-compareGroups(sex ~ . ,regicor)
#createTable(res, hide.no = 'no')
varinfo(res)