https://github.com/tdhock/inlinedocs
Convert inline comments and examples to Rd documentation files
https://github.com/tdhock/inlinedocs
Last synced: 3 days ago
JSON representation
Convert inline comments and examples to Rd documentation files
- Host: GitHub
- URL: https://github.com/tdhock/inlinedocs
- Owner: tdhock
- Created: 2014-06-03T14:50:10.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2023-10-17T21:45:14.000Z (over 1 year ago)
- Last Synced: 2025-03-25T05:18:44.315Z (21 days ago)
- Language: R
- Size: 196 KB
- Stars: 2
- Watchers: 5
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.org
- Changelog: NEWS
Awesome Lists containing this project
- jimsghstars - tdhock/inlinedocs - Convert inline comments and examples to Rd documentation files (R)
README
[[http://inlinedocs.r-forge.r-project.org/][inlinedocs]]
** Installation
As of 3 June 2014, inlinedocs from R-Forge is deprecated (please do
not use it). Please instead install from CRAN or this GitHub
repository,
#+BEGIN_SRC R
install.packages("inlinedocs")
if(!requireNamespace("remotes"))install.packages("remotes")
remotes::install_github("tdhock/inlinedocs")
#+END_SRC
** Write documentation in comments
See [[http://inlinedocs.r-forge.r-project.org/][the R-Forge page]] for a summary of the kinds of comments that are
recognized as documentation by the default inlinedocs Parser Functions.
** Convert comments to documentation
Read comments in =pkg/R/*.R= files, then generate =pkg/man/*.Rd= files:
#+BEGIN_SRC R
inlinedocs::package.skeleton.dx("path/to/your/pkg")
#+END_SRC
** Write your own Parser Function to extend inlinedocs
Don't like the default syntax? Want to add a new feature? You can
write your own Parser Functions that take your code/comments from *.R
files as input, and return documentation as output.
Please read [[https://www.jstatsoft.org/article/view/v054i06][the JSS paper]] for an overview of how this works, and see
[[file:inst/testfiles/alternate.R]] for an example.