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.5)docstring_1.0.0.zip(r-4.4)docstring_1.0.0.zip(r-4.3)
docstring_1.0.0.tgz(r-4.5-any)docstring_1.0.0.tgz(r-4.4-any)docstring_1.0.0.tgz(r-4.3-any)
docstring_1.0.0.tar.gz(r-4.5-noble)docstring_1.0.0.tar.gz(r-4.4-noble)
docstring_1.0.0.tgz(r-4.4-emscripten)docstring_1.0.0.tgz(r-4.3-emscripten)
docstring.pdf |docstring.html✨
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.96 score 58 stars 1 packages 305 scripts 1.7k downloads 2 exports 29 dependencies

Last updated 3 years agofrom:815dcd9e04. Checks:9 OK. Indexed: yes.

TargetResultLatest binary
Doc / VignettesOKMar 19 2025
R-4.5-winOKMar 19 2025
R-4.5-macOKMar 19 2025
R-4.5-linuxOKMar 19 2025
R-4.4-winOKMar 19 2025
R-4.4-macOKMar 19 2025
R-4.4-linuxOKMar 19 2025
R-4.3-winOKMar 19 2025
R-4.3-macOKMar 19 2025

Exports:?docstring

Dependencies:brewcallrclicommonmarkcpp11descevaluatefsgluehighrknitrlifecyclemagrittrpkgbuildpkgloadprocessxpspurrrR6rlangroxygen2rprojrootstringistringrvctrswithrxfunxml2yaml

Introduction to docstring

Dason Kurkiewicz

Rendered fromdocstring_intro.Rmdusingknitr::rmarkdownon Mar 19 2025.

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