क्या मैं स्वचालित रूप से roxygen2 उदाहरणों से testthat के लिए यूनिट परीक्षण उत्पन्न कर सकता हूं?

Question

मैं आर के लिए पीकेएनसीए पैकेज पर काम कर रहा हूं। परीक्षण कोड विकसित करते समय, कुछ परीक्षण भी अच्छे उदाहरण होंगे। मैं उन्हें दोनों (परीक्षण और उदाहरण) के रूप में रखना चाहता हूं। क्या कोई तरीका है कि मैं roxygen2 दस्तावेज के भीतर कुछ एम्बेड कर सकता हूं जो परीक्षण में भी कॉपी हो जाएगा?

क्या मैं के बारे में सोच रहा हूँ है प्रलेखन की तरह:

#' @exampleTest 
#' set.seed(5) 
#' rnorm(1) ## -0.8409 

और ऐसे ही एक परीक्षण उत्पन्न होगा:

expect_equal({set.seed(5) 
       rnorm(1)}, -0.8409, tol=1e-4) 

(सहने तथ्य यह है कि यह एक नंबर और है से आया उदाहरण में दिखाए गए अंकों की संख्या।)

Answer 1

में बताए गए अनुसार devtools::run_examples() का उपयोग करें। जब आप आर सीएमडी चेक चलाते हैं तो फ़ंक्शन उदाहरणों का परीक्षण किया जाता है। यह testthat का हिस्सा नहीं है बल्कि मानक आर पैकेज जांच प्रणाली के बजाय है।

Answer 2

एक तरीका है, लेकिन यह उतना आसान नहीं है जितना आप चाहें। आपको अपने @examples ब्लॉक के अंदर testthat फ़ंक्शन कॉल करना होगा। यहाँ एक उदाहरण समारोह है:

#' @examples 
#' testStrings <- c("1234567890", 
#'     "123 456 7890") 
#' 
#' testthat::expect_equal(extractPhoneNumbers(testStrings), "0123") 
extractPhoneNumbers <- function(inputStr) { 
    # check input: 
    if (!is.character(inputStr)) { 
     stop("'inputStr' must be a (vector of) string(s)!") 
    } 

    # imports 
    `%>%` <- stringr::`%>%` 
    replace_all <- stringr::str_replace_all 
    extract_all <- stringr::str_extract_all 

    # intermediary regex's 
    visualDelimitersRegex <- "[()+\\-_. ]" 
    phoneNumberRegex <- "[:digit:]{10}" 

    inputStr %>% 
    replace_all(pattern = visualDelimitersRegex, replacement = "") %>% 
    extract_all(pattern = phoneNumberRegex) 
} 

जब आप चलाने devtools::run_examples() या devtools::check, दोनों त्रुटियों के बाद से testthat::expect_equal() करने के लिए कॉल एक त्रुटि फेंकता फेंक देते हैं। devtools::check से

उदाहरण आउटपुट लग रहा है

*** SNIP *** 
* checking for unstated dependencies in examples ... OK 
* checking examples ... ERROR 
Running examples in ‘demoPkg-Ex.R’ failed 
The error most likely occurred in: 

> base::assign(".ptime", proc.time(), pos = "CheckExEnv") 
> ### Name: extractPhoneNumbers 
> ### Title: Extract Phone Numbers 
> ### Aliases: extractPhoneNumbers 
> 
> ### ** Examples 
> 
> testStrings <- c("1234567890", 
+     "123 456 7890") 
> 
> testthat::expect_equal(extractPhoneNumbers(testStrings), "0123") 
Error: extractPhoneNumbers(testStrings) not equal to "0123" 
Modes: list, character 
Length mismatch: comparison on first 1 components 
Component 1: 1 string mismatch 
Execution halted 
* checking for unstated dependencies in ‘tests’ ... OK 
* checking tests ... 
    Running ‘testthat.R’ 
OK 
* checking PDF version of manual ... OK 
* DONE 

Status: 1 ERROR