-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
55 lines (39 loc) · 1.3 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
options(pins.progress=FALSE)
```
# datatxt
<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
<!-- badges: end -->
datatxt provides utilities for working with the `data.txt` specification.
Currently, it provides a function, `narrate()`, that enables automatic
generation of data documentation. See [https://datatxtdoc.netlify.com/](https://datatxtdoc.netlify.com/) for an example.
## Installation
You can install the development version of datatxt with
``` r
# install.packages("remotes")
remotes::install_github("datatxtorg/datatxt")
```
## Example
We can generate data documentation by passing the URL of the `data.txt` to
`narrate()`:
```{r example, message=FALSE, progress = FALSE}
library(datatxt)
temp_dir <- tempdir()
narrate("https://datatxt.org/data.txt", output_dir = temp_dir)
list.files(temp_dir)
```
We can then inspect the contents of one of these files:
```{r warning=FALSE}
cat(readLines(file.path(temp_dir, "iris.md")), sep = "\n")
```