分享
三行代码  ›  专栏  ›  技术社区  ›  rvl

不一致样式Rd用法部分

  •  0
  • rvl  · 技术社区  · 3 天前

    新版本的 罗西根2 包已导致对包的文档文件的实质性更改。例如,将四个函数合并为一个函数的“用法”部分 .Rd 文件如下:

    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, ...)
    

    请注意,第一个、第三个和第四个函数在一行中显示它们的参数,而第二个函数的参数以堆叠格式显示。这似乎前后矛盾。前一个版本没有隐藏第二个函数的参数(当然是用几行代码包装的)。

    我希望我的文件是一致的。如果一个函数的用法呈现这样的参数堆积,那么它们都应该。但我真的不想把它们堆起来。我怎样才能控制这一切?

    1 回复  |  直到 3 天前
        1
  •  1
  •   duckmayr    3 天前

    您可以通过编辑 DESCRIPTION 包含以下行的文件:

    Roxygen: list(old_usage = TRUE)
    

    (参见 NEWS 对于7.0.0版。)