has_examples_in_rds: Checks if an R documentation file supplies one or more...
In richelbilderbeek/goodpracticeeighteen: tests if a file its documentation contains examples
Description
Usage
Arguments
Value
Author(s)
Examples
View source: R/has_examples_in_rd.R
Description
Checks if an R documentation file supplies one or more examples
Usage
1
has_examples_in_rds(rd_filenames)
Arguments
rd_filenames
names of R documentation (.Rd) files. These are commonly located in a package its 'man' folder
Value
a vector of which every element may be TRUE, FALSE or NA
Author(s)
Richel Bilderbeek
Examples
1
2
filenames <- find_paths(c("f_with_examples.Rd", "f_without_examples.Rd"))
testit::assert(has_examples_in_rds(filenames) == c(TRUE, FALSE))
richelbilderbeek/goodpracticeeighteen documentation built on May 27, 2019, 7:59 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Value Author(s) Examples
View source: R/has_examples_in_rd.R
Description
Checks if an R documentation file supplies one or more examples
Usage
1 | has_examples_in_rds(rd_filenames)
|
Arguments
rd_filenames |
names of R documentation (.Rd) files. These are commonly located in a package its 'man' folder |
Value
a vector of which every element may be TRUE, FALSE or NA
Author(s)
Richel Bilderbeek
Examples
1 2 | filenames <- find_paths(c("f_with_examples.Rd", "f_without_examples.Rd"))
testit::assert(has_examples_in_rds(filenames) == c(TRUE, FALSE))
|
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.