如何为 R 包创建具有动态输入的函数？

Question

我正在创建一个 R 包。我有一个功能需要用户提供一些动态输入才能产生所需的输出。我目前使用readline() 作为动态输入法。问题是我不知道如何使它适用于roxygen2examples，也不知道如何使用testthat（或任何其他方法）正确测试它。

如果有更好的方法来获取用户输入，那就太好了。

这是一个与我的函数具有相同问题的最小函数。

#' Dynamic Input Example
#'
#' @param input A number
#'
#' @return Console input times 2 minus 1
#' @export
#'
#' @examples
#' exampler(4)
exampler <- function(input){
  dynamic_input <- as.numeric(readline(prompt=paste("Give a value between", input*3-1, "and", input*7+2)))
  return(dynamic_input*2-1)
}

Answer 1

使用此语法可防止函数示例在检查期间运行：

#' @examples \dontrun{interactive_function()}

对于测试套件，我们可以使用以下内容（需要 mockery 包）：

test_that("interactive_function works with defaults", {

    mockery::stub(interactive_function, "readline", "dummy return value for mock function")
 
    testvalue <- interactive_function()

    [testcode ...]
 
})

使用该代码，如果 interactive_function 调用了 readline 函数，则 mockery 将在测试期间替换它并返回“模拟函数的虚拟返回值”。 mockery 还提供了跟踪函数调用甚至调用函数时使用的参数的函数。所有非常方便的东西;)