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

https://github.com/r-lib/yaml

R package for converting objects to and from YAML
https://github.com/r-lib/yaml

cran r yaml

Last synced: 13 days ago
JSON representation

R package for converting objects to and from YAML

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%"
)
```

# yaml

[![R-CMD-check](https://github.com/r-lib/yaml/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-lib/yaml/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/r-lib/yaml/graph/badge.svg)](https://app.codecov.io/gh/r-lib/yaml)

yaml provides R bindings to [libyaml](https://pyyaml.org/wiki/LibYAML), a fast [YAML](https://yaml.org/) parser and emitter.

## Installation

Install from CRAN:

```{r}
#| eval: false
install.packages("yaml")
```

Or install the development version from GitHub:

```{r}
#| eval: false
# install.packages("pak")
pak::pak("r-lib/r-yaml")
```

## Usage

```{r}
library(yaml)
```

Parse YAML with `yaml.load()` or `read_yaml()`:

```{r}
yaml.load(
"
- 1
- 2
- 3
"
)

yaml.load(
"
a: 1
b: 2
"
)
```

Convert R objects to YAML with `as.yaml()` or `write_yaml()`:

```{r}
cat(as.yaml(list(a = 1:3, b = 4:6)))
```

See `vignette("yaml")` for more details on handlers, formatting options, and advanced usage.