Provides Docstring Capabilities to R Functions

Provides the ability to display something analogous to Python's docstrings within R. By allowing the user to document their functions as comments at the beginning of their function without requiring putting the function into a package we allow more users to easily provide documentation for their functions. The documentation can be viewed just like any other help files for functions provided by packages as well.


News

NEWS

CHANGES IN docstring VERSION 1.0.0

  • This is the initial release.

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("docstring")

1.0.0 by Dason Kurkiewicz, 3 years ago


https://github.com/dasonk/docstring


Report a bug at https://github.com/dasonk/docstring/issues?state=open


Browse source code at https://github.com/cran/docstring


Authors: Dason Kurkiewicz [aut, cre] , Neal Fultz [ctb]


Documentation:   PDF Manual  


GPL-2 license


Imports roxygen2, utils, tools

Suggests devtools, rstudioapi, knitr, rmarkdown


See at CRAN