【问题标题】:R Package Check(): "All declared Imports should be used"R Package Check(): \"所有声明的 Imports 都应该被使用\"
【发布时间】:2022-11-09 16:49:24
【问题描述】:

起始情况:

我只为自己编写一小部分功能(不是 CRAN;在 GitHub 上,但不是公共的),并在计算机上本地开发。这主要是因为我是 R 的新手并学习编写第一个包。

我正在使用devtools,在load_all() 和check() 之后,我得到了这个“注意”:

-- R CMD check results -------------------------------------------------------------------------------------------- MondelezR 0.1.0 ----
Duration: 21.1s

> checking dependencies in R code ... NOTE
  Namespace in Imports field not imported from: 'tibble'
    All declared Imports should be used.

0 errors v | 0 warnings v | 1 note x

问题:

我做错了什么还是我可以忽略的已知/预期问题?

更多背景:

我正在使用tibble()

在我的包中,“在文件中查找”显示我以不同的方式在四个文件中使用了tibble:

描述文件:

[First Section of File Omitted]
Encoding: UTF-8
RoxygenNote: 7.2.0
Imports: 
    stringr,
    dplyr,
    purrr,
    tibble,
    magrittr
Suggests: 
    testthat (>= 3.0.0)
Config/testthat/edition: 3

(我没有看到其他导入包的消息。)

功能:mdlz_otm_filter.R

[omitted]
#' @examples
#' df_otm_final <- tibble::tibble(
[omitted]

我只是在示例中使用tibble,而不是在函数本身中,相关部分如上所示。

文档:mdlz_otm_filter.Rd

从上述函数创建的 roxygen2 文档显示了完全相同的示例,但作为文档。

测试:test-mdlz_make_KEY1.R

test_that("POSTAL LANE2 works as expected", {

  df_test <- tibble::tibble(ORIG_ZIP = c("18615", "12345", "a5J 1u8"),
                            DEST_ZIP = c("1234", "23456", "i9y2b4"),
                            FINAL_KEY = c("18615-01234","12345-23456","A5J1U8-I9Y2B4"))

  expect_identical(mdlz_make_POSTAL_LANE(df_test$ORIG_ZIP,
                                         df_test$DEST_ZIP),
                   df_test$FINAL_KEY)
})

尝试从DESCRIPTION中删除tibble

我尝试从DESCRIPTION文件的Imports:中删除tibble,但正如我所料,我得到了这个:

-- R CMD check results -------------------------------------------------------------------------------------------- MondelezR 0.1.0 ----
Duration: 26.6s

> checking for unstated dependencies in examples ... WARNING
  '::' or ':::' import not declared from: 'tibble'

> checking for unstated dependencies in 'tests' ... WARNING
  '::' or ':::' import not declared from: 'tibble'

0 errors v | 2 warnings x | 0 notes v

所以...警告比笔记我想。

研究:

谷歌搜索一开始就把我带到了这些帖子:

RStudio Community Meta-Package这家伙的问题是他需要在他试图放入他的元包中的每个包中使用函数。我的问题是我已经在使用tibble 并且无论如何都会收到通知。

SO devtools R CMD check NOTE 但是这个似乎不适用,因为我是在我的包中使用tibble,而这个人正试图将其删除。

帮助?

我不知道如何清除该笔记,我是否应该担心它,或者为什么我会得到它,因为我使用的是tibble,如上所示。试图学习,所以一个说明性的答案是值得赞赏的。先感谢您。

【问题讨论】:

  • 这可能意味着您在Imports: 中有tibble 在DESCRIPTION 中,但实际上并没有在NAMESPACE 中导入它。如果你只在测试中使用它,你可以将它从 Imports: 移动到 Suggests: (但应该通过 if (requireNamespace("tibble", quietly=TRUE)) .... 在测试中使用它)
  • 你是对的,它不在NAMESPACE 中。我添加了#' @importFrom tibble "tibble",然后添加了load_all() 和check(),现在它已被清除,因为它已添加到NAMESPACE,但我不明白为什么我需要为tibble 而不是我的其他包正在使用,例如 dplyr 或 stringr。我认为您是在暗示我在测试中的使用与在我正在编写的函数中直接使用时不同(?)。和例子是不同的野兽?我会去阅读更多......谢谢。

标签: r devtools r-package


【解决方案1】:

似乎 devtools 检查功能正在您的某些功能文档roxygen Docs 中寻找带有包 tibble 的 importFrom 标记。

在使用库 tibble 的函数文档中添加 @importFrom tibble tibble 可能会删除该注释。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2011-09-07
    • 1970-01-01
    • 2016-12-03
    • 2014-01-14
    • 2014-03-09
    • 1970-01-01
    • 2012-03-09
    • 2013-02-22
    相关资源
    最近更新 更多