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.
| Version: | 1.0.0 |
| Imports: | roxygen2, utils, tools |
| Suggests: | devtools, rstudioapi, knitr, rmarkdown |
| Published: | 2017-03-24 |
| DOI: | 10.32614/CRAN.package.docstring |
| Author: | Dason Kurkiewicz [aut, cre], Neal Fultz [ctb] |
| Maintainer: | Dason Kurkiewicz <dasonk at gmail.com> |
| BugReports: | https://github.com/dasonk/docstring/issues?state=open |
| License: | GPL-2 |
| URL: | https://github.com/dasonk/docstring |
| NeedsCompilation: | no |
| Materials: | NEWS |
| CRAN checks: | docstring results |
| Reference manual: | docstring.pdf |
| Vignettes: |
Introduction to docstring |
| Package source: | docstring_1.0.0.tar.gz |
| Windows binaries: | r-devel: docstring_1.0.0.zip, r-release: docstring_1.0.0.zip, r-oldrel: docstring_1.0.0.zip |
| macOS binaries: | r-release (arm64): docstring_1.0.0.tgz, r-oldrel (arm64): docstring_1.0.0.tgz, r-release (x86_64): docstring_1.0.0.tgz, r-oldrel (x86_64): docstring_1.0.0.tgz |
| Reverse imports: | aggutils |
Please use the canonical form https://CRAN.R-project.org/package=docstring to link to this page.