Package: document 4.0.1.9000

document: Run 'roxygen2' on (Chunks of) Single Code Files

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.

Authors:Andreas Dominik Cullmann [aut, cre]

document_4.0.1.9000.tar.gz
document_4.0.1.9000.zip(r-4.7)document_4.0.1.9000.zip(r-4.6)document_4.0.1.9000.zip(r-4.5)
document_4.0.1.9000.tgz(r-4.6-any)document_4.0.1.9000.tgz(r-4.5-any)
document_4.0.1.9000.tar.gz(r-4.7-any)document_4.0.1.9000.tar.gz(r-4.6-any)
document_4.0.1.9000.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
document/json (API)

# Install 'document' in R:

install.packages('document', repos = c('https://fvafrcu.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://gitlab.com/fvafrcu/document

On CRAN:

5.13 score 267 scripts 670 downloads 1 mentions 4 exports 35 dependencies

Last updated from:881e2a0a05. Checks:9 OK. Indexed: yes.

Target	Result	Time
linux-devel-x86_64	OK	144
source / vignettes	OK	238
linux-release-x86_64	OK	122
macos-release-arm64	OK	101
macos-oldrel-arm64	OK	77
windows-devel	OK	77
windows-release	OK	80
windows-oldrel	OK	66
wasm-release	OK	106

Exports:document get_dpd man usage

Dependencies:backports brew callr checkmate cli commonmark cpp11 curl desc digest evaluate fritools fs glue highr knitr lifecycle otel pkgbuild pkgload prettyunits processx ps R6 rcmdcheck rlang roxygen2 rprojroot rstudioapi sessioninfo withr xfun xml2 xopen yaml

An Introduction to document

Rendered fromIntroduction_to_document.Rmdusingknitr::rmarkdown

Last update: 2022-08-17
Started: 2017-04-23

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
Document a Single R Code File	document-package
Document (Chunks of) an R Code File	document
Display a Help Page From a File's Documentation	man
Return the Usage of a Function From Within the Function	usage