Have you ever been tempted to create roxygen2-style documentation
for one of your functions that was not part of one of your packages (yet)?
This is exactly what this package is about: running
roxygen2::roxygenize on (chunks of)
a single code file.
This package enables you to
create function documentation with roxygen2
detect code/documentation mismatches
save the documentation to disk
view the documentation in your interactive R session
You will probably be looking for
man, the remaining functions are mainly
for internal use.
R is a programming language that supports and checks documentation for
program libraries (called ‘packages’). The package roxygen2 provides a
tool for creating documentation from annotated source code - much like
And R is a free software environment for statistical computing and graphics, used by people like me who start out hacking down code, eventually pouring chunks of code into functions (and sometimes even ending up creating and documenting packages). Along that work flow you cannot use R's documentation system, let alone roxygen2, unless you have come to forge your code into a package.
I am fully aware of the fact that roxygen2 is meant to document packages, not single code chunks. So should you. Nevertheless I feel the temptation to use roxygen2-style comments in code chunks that are not part of any package. And to convert them to pdf for better readability.
This package writes to disk, so never run as superuser.
This package is basically a wrapper to
roxygen2. It internally creates a temporary package from the
code file provided (using
which it then passes to
R CMD commands run by callr.
(https://cran.r-project.org/package=docstring) also creates temporary
help pages as well but using a different technical approach (allowing you to
view them in the
RStudio help pane). But it creates them from python
docstring-like comments it then parses into roxygen2.
And it does not write to file so far.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.