Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jsta/autodatadoc

Example of automated data documentation for R packages
https://github.com/jsta/autodatadoc

Last synced: about 2 months ago
JSON representation

Example of automated data documentation for R packages

Awesome Lists containing this project

README

        

---
output: github_document
---

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```

# autodatadoc

The goal of autodatadoc is to demonstrate how to create automated data documentation for R packages use the `@eval` roxygen tag. See [blog post] for details.

## Installation

You can install the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("jsta/autodatadoc")
```
## Example

```{r example}
library(autodatadoc)
?population
```