CODEWITHSUNDEEP
rdocumentationdoxygenroxygen
XtrimA
XtrimA

Reputation: 143

Can Roxygen really document R script (not a package) just like Doxygen does for C++?

Roxygen is inspired by the Doxygen documentation system that is used by C, C++ programmers. I have used Doxygen and I find it really easy to document any program as long as you have the doxygen comment. It also generate call graphs for functions and classes. I thought roxygen would work the same way but when I search for roxygen help, I only find solution to documenting R packages.

I have checked Hadley Wickham's online roxygen2 help but that does not describe anything about the R script documentation.

My scripts sometimes become 500-1000 lines and have several functions which I always document with the comments. I want to generate PDF or HTML documentation with graph-viz diagrams. Is Roxygen capable of making call-graph and document standalone R scripts?

Upvotes: 7

Views: 2188

Answers (2)

SwatchPuppy
SwatchPuppy

Reputation: 334

Though this is an old thread, for future reference, the following library is able to achieve that:

https://rdrr.io/cran/document/

From its docs: Have you ever been tempted to create 'roxygen2'-style documentation comments 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' on (chunks of) a single code file.

Upvotes: 3

Roman Luštrik
Roman Luštrik

Reputation: 70623

No, roxygen2 will work only for writing package documentation. Sounds to me you're after a report generating tool. You can use knitr for that. You can include code, comments, text, MathJax, or even use LaTeX. It also supports table of contents and references. This is by no means an exhaustive list of functionality. With some logical limitations, you can produce pdf and html documents, among others.

Upvotes: 3

Related Questions