Package: docstring 1.0.0

docstring: 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.

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

docstring_1.0.0.tar.gz
docstring_1.0.0.zip(r-4.7)docstring_1.0.0.zip(r-4.6)docstring_1.0.0.zip(r-4.5)
docstring_1.0.0.tgz(r-4.6-any)docstring_1.0.0.tgz(r-4.5-any)
docstring_1.0.0.tar.gz(r-4.7-any)docstring_1.0.0.tar.gz(r-4.6-any)
docstring_1.0.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html
card.svg |card.png
docstring/json (API)
NEWS

# Install 'docstring' in R:
install.packages('docstring', repos = c('https://dasonk.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/dasonk/docstring/issues

On CRAN:

Conda:

devtoolsdocstringdocumentationdocumentation-toolroxygen-style

7.84 score 59 stars 1 packages 388 scripts 1000 downloads 2 exports 24 dependencies

Last updated from:815dcd9e04. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK141
source / vignettesOK192
linux-release-x86_64OK134
macos-release-arm64OK154
macos-oldrel-arm64OK196
windows-develOK78
windows-releaseOK80
windows-oldrelOK74
wasm-releaseOK130

Exports:?docstring

Dependencies:brewcallrclicommonmarkcpp11descevaluatefsgluehighrknitrlifecyclepkgbuildpkgloadprocessxpsR6rlangroxygen2rprojrootwithrxfunxml2yaml

Introduction to docstring

Rendered fromdocstring_intro.Rmdusingknitr::rmarkdownon May 13 2026.

Last update: 2017-03-17
Started: 2017-03-16