https://github.com/datatxtorg/datatxt
Tools for working with the data.txt specification
https://github.com/datatxtorg/datatxt
Last synced: 4 months ago
JSON representation
Tools for working with the data.txt specification
- Host: GitHub
- URL: https://github.com/datatxtorg/datatxt
- Owner: datatxtorg
- License: other
- Created: 2019-11-07T08:22:39.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-11-12T23:25:03.000Z (over 5 years ago)
- Last Synced: 2024-08-13T07:15:27.223Z (8 months ago)
- Language: R
- Homepage:
- Size: 9.77 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - datatxtorg/datatxt - Tools for working with the data.txt specification (R)
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
options(pins.progress=FALSE)
```
# datatxt
[](https://www.tidyverse.org/lifecycle/#experimental)
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")
```