【问题标题】:How to write an example function for r package如何为 r 包编写示例函数
【发布时间】:2018-02-19 19:22:27
【问题描述】:

我有一个包含大约 50 个函数的包。每一个都有例子。这些示例使用 .rda 数据文件。 大多数情况下,这些示例都很短并且可以正常工作。 但是,我有 10 个函数依赖于包中其他函数的先前操作(全部以完全相同的方式),因此示例变得相当长。 因此有没有办法创建一个函数来为这些高阶函数提供数据操作,这样我就不必把示例文本弄乱了?

【问题讨论】:

    标签: r r-package


    【解决方案1】:

    假设你有类似的东西

    a <- funca()
    b <- funcb(a)
    c <- funcc(b)
    d <- funcd(c)
    

    您需要将d 用于剩余的 10 个函数示例,我将仅包含 d 作为示例数据集。您可以记录数据集的生成方式,但在您的 10 个函数的示例中,您可以按原样使用它。

    【讨论】:

    • Theanks @EricWatt。希望这不是一个愚蠢的问题,但我可以记录数据集是如何从数据文档文件中的现有数据集创建的吗?如果不是,你把它放在哪里?
    • 我遵循R packages 指南。在此处查看Documenting datasets 部分:r-pkgs.had.co.nz/data.html 使用data.R 记录数据的示例可以在ggplot2 中找到:github.com/tidyverse/ggplot2/blob/master/R/data.R
    • 另外,请注意该页面上关于将您的代码放在 R 脚本中的 data-raw 中的建议。这很好,因此您可以重现数据集。然后使用data.R 中的文档,以便人们可以使用help(d) 了解有关您的d 数据集的更多信息。
    猜你喜欢
    • 1970-01-01
    • 2023-03-24
    • 1970-01-01
    • 2020-01-19
    • 1970-01-01
    • 1970-01-01
    • 2021-09-27
    • 1970-01-01
    • 2021-03-06
    相关资源
    最近更新 更多