样式不一致的 Rd 使用部分

Question

roxygen2 软件包的新版本对我的软件包的文档文件进行了重大更改。例如，合并在一个 .Rd 文件中的四个函数的 "Usage" 部分如下所示：

contrast(object, ...)

## S3 method for class 'emmGrid'
contrast(
  object,
  method = "eff",
  interaction = FALSE,
  by,
  offset = NULL,
  scale = NULL,
  name = "contrast",
  options = get_emm_option("contrast"),
  type,
  adjust,
  simple,
  combine = FALSE,
  ratios = TRUE,
  ...
)

## S3 method for class 'emmGrid'
pairs(x, reverse = FALSE, ...)

## S3 method for class 'emmGrid'
coef(object, ...)

请注意，第一个、第三个和第四个函数在一行中显示它们的参数，而第二个函数的参数以堆叠格式显示。这似乎不一致。之前的版本展示了第二个函数的未堆叠参数（但当然包含了几行）。

我希望我的文档保持一致。如果一个函数的用法呈现像这样堆叠的参数，那么它们都应该。但我真的宁愿 none 堆叠起来。我如何控制这是如何完成的？

Answer 1

您可以通过编辑 DESCRIPTION 文件以包含以下行来执行此操作：

Roxygen: list(old_usage = TRUE)

（请参阅 NEWS 版本 7.0.0 的 "Default usage" 部分。）

样式不一致的 Rd 使用部分

Inconsistent style Rd usage section

r

roxygen2

rd