Utilities to Extract and Process 'YAML' Fragments

Provides a number of functions to facilitate extracting information in 'YAML' fragments from one or multiple files, optionally structuring the information in a 'data.tree'. 'YAML' (recursive acronym for "YAML ain't Markup Language") is a convention for specifying structured data in a format that is both machine- and human-readable. 'YAML' therefore lends itself well for embedding (meta)data in plain text files, such as Markdown files. This principle is implemented in 'yum' with minimal dependencies (i.e. only the 'yaml' packages, and the 'data.tree' package can be used to enable additional functionality).


yum 📦

yum: YAML Utilities & More

The goal of yum is to provide a number of functions to work with files that contain one or more YAML fragments. Several packages (the rock, dct, and justifier packages) leverage the YAML format to facilitate systematic encoding of information in a format that is both machine- and human-readable. The yum package provides a number of functions to facilitate this in a uniform manner with minimal dependencies (i.e. only yaml, suggesting data.tree to enable additional functionality).

Pipeline status

Coverage status

Installation

You can install the released version of yum from CRAN with:

install.packages('yum');

You can install the development version of yum from GitLab with:

devtools::install_gitlab('r-packages/yum');

(assuming you have devtools installed; otherwise, install that first using the install.packages function)

Dependencies

yum was created to have minimal dependencies. It requires [yaml::yaml] to be able to actually load (parse) the extracted YAML fragments, and you will often want to have [data.tree::data.tree] available to organise the results in a tree if they have a hierarchical structure. Therefore, yum does have some dependencies through those two suggested packages. Of these, yaml only has one dependency, but data.tree has a few more. Specifically, the dependency network looks like this:

News

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("yum")

0.0.1 by Gjalt-Jorn Peters, 2 years ago


https://r-packages.gitlab.io/yum


Report a bug at https://gitlab.com/r-packages/yum/issues


Browse source code at https://github.com/cran/yum


Authors: Gjalt-Jorn Peters [aut, cre]


Documentation:   PDF Manual  


GPL-3 license


Imports yaml

Suggests covr, data.tree, here, testthat


Imported by behaviorchange, justifier, psyverse, rock.


See at CRAN