The hardware and bandwidth for this mirror is donated by METANET, the Webhosting and Full Service-Cloud Provider.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]metanet.ch.
tldrDocs provides tldrPages
documentation for many of the commonly-used objects included in the base
distribution of R. For example, there is documentation included for all
of the distribution functions exported in stats—below,
we show the documentation for the *pois() functions:
Also included is documentation for the apply() family of
functions. Here, we include the documentation for lapply(),
sapply(), and vapply():
You can install the development version of tldrDocs from GitHub with:
if (!requireNamespace("remotes")) install.packages("remotes")
remotes::install_github("jamesotto852/tldrDocs")Once you have installed tldrDocs, you do not need to
(and should not) load it via library().
tldrPages::tldr() will be able to find the installed
documentation for base R functions automatically.
The goal of tldrDocs is not to provide documentation for every function exported in base R—just those that are commonly used and/or have aspects that are difficult to remember. If you believe that documentation is missing or existing documentation needs correcting, please open an issue or fork this repository and submit a PR. For help on writing tldrPages documentation, see the tldrPages repo.
Note, only base packages are documented via tldrDocs—if you are a package developer that wants to include tldrPages documentation in a package, see tldrExample for an example of a package with tldrPages documentation.
These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.