Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

roxygen2 how to not run example file

Tags:

r

roxygen2

I am well aware of how to have roxygen not run an example when the code is directly in the roxygen comments. However, some example may be somewhat verbose or you would want you examples compiled in an examples directory. In which case the @example file_path works fine but I can't figure out how to have roxygen not run (i.e. \dontrun) the example file.

This is admitted very similar to this question but the comments show that this problem was not answered.

test.R

# this does not work
#' @title test_fun
#' @example \dontrun{examples/test_example.R}
test <- function(){
    print("hello")
}

# this does
#' @title test
#' @examples 
#' \dontrun{
#' test()
#' }
test <- function(){
    print("hello")
}

test_example.R

test()

How can I get the former approach to work?

like image 826
cdeterman Avatar asked Oct 30 '22 23:10

cdeterman


1 Answers

It seems I'm able to accomplish this by using roxygen2-style comments for the \dontrun{} block in the example file. This gets around the limitation in Michal's answer.

Create an example file that looks like this:

#' \dontrun{
test()
#' }

More reliably, you can wrap your example in an if(interactive()) {} block, which won't be run during checks but allows you to manually run through the example.

like image 82
amc Avatar answered Nov 08 '22 03:11

amc