test.file

File name of R code file with inlinedocs to parse and check.

try to make a package and run CRAN checks?

CRAN.checks

verbose

Check an R code file with inlinedocs to see if the
<code><a rd-options="" href="/link/extract.docs.file?package=inlinedocs&version=2019.12.5" data-mini-rdoc="inlinedocs::extract.docs.file">extract.docs.file</a></code> parser accurately extracts all the code inside!
The code file should contain a variable .result which is the
documentation list that you should get when you apply
<code><a rd-options="" href="/link/extract.docs.file?package=inlinedocs&version=2019.12.5" data-mini-rdoc="inlinedocs::extract.docs.file">extract.docs.file</a></code> to the file. We check for identity of elements
of elements of the list, so the order of elements should not
matter, and thus this should be a good robust unit test.

Generates Rd files from R source code with comments.
The main features of the default syntax are that
(1) docs are defined in comments near the relevant code,
(2) function argument names are not repeated in comments, and
(3) examples are defined in R code, not comments.
It is also easy to define a new syntax.

Toby Hocking

inlinedocs

Convert Inline Comments to Documentation

Toby Dylan Hocking

Keith Ponting

Thomas Wutzler

Philippe Grosjean

Markus M<c3><bc>ller

R Core Team 

test.file function

Check an R code file with inlinedocs to see if the
<code><a rd-options='' href='extract.docs.file'>extract.docs.file</a></code> parser accurately extracts all the code inside!
The code file should contain a variable .result which is the
documentation list that you should get when you apply
<code><a rd-options='' href='extract.docs.file'>extract.docs.file</a></code> to the file. We check for identity of elements
of elements of the list, so the order of elements should not
matter, and thus this should be a good robust unit test.

test.file: test file

Description

Usage

Arguments

See Also