Learn R Programming

yamlet (version 1.2.2)

Versatile Curation of Table Metadata

Description

A YAML-based mechanism for working with table metadata. Supports compact syntax for creating, modifying, viewing, exporting, importing, displaying, and plotting metadata coded as column attributes. The 'yamlet' dialect is valid 'YAML' with defaults and conventions chosen to improve readability. See ?yamlet, ?decorate, ?modify, ?io_csv, and ?ggplot.decorated.

Copy Link

Version

Install

install.packages('yamlet')

Monthly Downloads

235

Version

1.2.2

License

GPL-3

Maintainer

Tim Bergsma

Last Published

June 18th, 2025

Functions in yamlet (1.2.2)

as.data.frame.dvec

Coerce Decorated Vector to Data Frame

Coerce to Decorated

as_dvec.character

Coerce Character to Decorated Vector

Coerce to Decorated Vector

as.character.yamlet

Coerce Yamlet to Character

as_decorated.default

Coerce to Decorated by Default

as.integer.classified

Coerce Classified to Integer

Coerce Units to Decorated Vector

as_dvec.numeric

Coerce Numeric to Decorated Vector

as_spork.unit_string

Coerce Unit String to Spork

as.data.frame.yamlet

Coerce Yamlet to Data Frame

as_spork.symbolic_units

Coerce Symbolic Units to Spork

as_unit_string.units

Coerce Units to Unit String.

Coerce to Unit String

Coerce Units to Spork

as_unit_string.symbolic_units

Coerce Symbolic Units to Unit String.

arrange.decorated

Arrange Decorated

as_dvec.integer

Coerce Integer to Decorated Vector

Coerce Decorated Vector to Units

as.character.yam

Coerce Yam to Character

Coerce to Yamlet

as_dvec.logical

Coerce Logical to Decorated Vector

Coerce List to Yamlet

Calculate a Cell Value

canonical.yamlet

as_unit_string.character

Coerce Character to Unit String

as_unit_string.factor

Coerce Factor to Unit String

as_yamlet.character

Coerce Character To Yamlet Format

as_dvec.complex

Coerce Complex to Decorated Vector

as_yam.character

Coerce Character to Yam

Coerce Decorated Vector to Decorated Vector

as_yamlet.data.frame

Coerce Data Frame to Yamlet

classified.dvec

Classify Decorated Vector

Classify Something

Combine Decorated Vector

Combine Classified

classified.factor

Create Classified from Factor

Enforce Canonical Order

Coerce Yamlet to Yam

canonical.decorated

Sort Decorations

classified.default

Create Classified by Default

decorations.data.frame

Retrieve Decorations for Data Frame

Retrieve Decorations

classified.data.frame

Classify Data Frame

as_yamlet.yamlet

Coerce Yamlet to Yamlet

Coerce Data.frame to Decorated

Decorate a List-like Object

classified.classified

Create Classified from Classified

Coerce Yam To Yamlet Format

Conditionalize Attributes

Coerce Common Type to Decorated

desolve.classified

Desolve Guide for Classified

decorations_groups

Recover Groups Decorations

desolve.decorated

Desolve Guide for Decorated

desolve.data.frame

Desolve Data Frame

decorations_groups.data.frame

Recover Groups Decorations for Data Frame

Desolve Guide for Decorated Vector

explicit_guide.dvec

Coerce Decorated Vector Guide to Something More Explicit

decorate.data.frame

Decorate Data Frame

decorate_groups.data.frame

Capture Groups as Decorations for Data Frame

conditionalize.data.frame

Conditionalize Attributes of Data Frame

decorate_groups

Capture Groups as Decorations

Coerce Guide to Something More Explicit

explicit_guide.data.frame

Coerce Data Frame Guide to Something More Explicit

Render Scripted Attributes of Indicated Components

drop_title.dvec

Drop Title for Decorated Vector

decorate.character

Decorate Character

full_join.decorated

Full_join Decorated

gather.decorated

Gather a Decorated Data Frame

drop_title.decorated

Drop Title for Decorated

ggplot.decorated

Create a New ggplot for a Decorated Data Frame

enscript.default

Render Scripted Attributes of Indicated Components by Default

ggplot_add.ggplot_isometric

Add Isometry to Plot Object

explicit_guide.yamlet

Coerce Yamlet Guide to Something More Explicit

Coerce Guide to Something More Implicit

implicit_guide.data.frame

Coerce Data Frame Guide to Something More Implicit

group_by.decorated

Group_by Decorated

footnote.decorated

Footnote Decorated

ggready.decorated

Prepare Decorated Data Frame for GGplot

filter.decorated

Filter Decorated

ggplot_add.ggplot_symmetric

Add Symmetry to Plot Object

ggplot_build.decorated_ggplot

Enable Automatic Labels and Units for ggplot

Import and Export Documented Tables

Format Decorated Vector

io_res.decorated

Export Resolved Table

io_csv.data.frame

Export Documented Table as CSV

io_csv.character

Import Documented Table as CSV

drop_title.default

Drop Title by Default

Footnote Something

group_by_decorations.data.frame

Groups by Decorations for Data Frame

Detect Revised Label Strategy

group_by_decorations

Group by Decorations

Test if Class is dvec

io_yamlet.data.frame

Export Data Frame Attributes as Yamlet

io_res.character

Import Documented Table as Resolved

io_table.character

Import Documented Table

io_table.data.frame

Export Documented Table

isConditional.default

Test Object is Conditional by Default

Check Parseable as Units

make_title.decorated

Make Title for Decorated

make_title.default

Make Title by Default

isConditional.list

Test List is Conditional

Test Object is Conditional

implicit_guide.dvec

Coerce Decorated Vector Guide to Something More Implicit

Prepare Data for GGplot

ggready.data.frame

Prepare Data Frame for GGplot

Import and Export Resolved Tables

Import and Export Documented Tables as CSV

inner_join.decorated

Inner_join Decorated

left_join.decorated

Left_join Decorated

Test Value is Levels

isLevels.character

Test Character Value is Levels

Infer Type of Guide

io_yamlet.yamlet

make_title.dvec

Make Title for Decorated Vector

isLevels.default

Test Value is Levels by Default

Enforce Isometry

Import and Export Yamlet

is_parseable.default

Check Something is Parseable as Units by Default

io_yamlet.character

Try To Look Like Another Equal-length Variable

Modify Attributes of Indicated Components

merge.decorated

Merge Decorated

Modify Attributes of Indicated Components by Default

mutate.decorated

Mutate Decorated

Promote Something

Print Decorated Vector

print.decorated_ggplot

Substitute Expressions, Titles, Labels and Aesthetics in ggplots

promote.default

Promote by Default

Try To Look Like Something Else

promote.data.frame

Promote Data Frame

print.decorated_xtable

Print Decorated Xtable

mimic.classified

Try To Make Classified Look Like Another Equal-length Variable

Reconcile Atttributes

Get Length of a Decorated Vector

Evaluate Named Arguments

names<-.decorated

Assign Names of Decorated

parsimonious.list

Reduce A List to its Simplest Sufficient Version

Reconcile Atttributes of List Members

resolve.classified

Resolve Classified

resolve.data.frame

Resolve Data Frame

Redecorate a List-like Object

Coerce List to Encoding

Calculate Substitute Values for Factor Levels

resolve.decorated

Resolve Guide for Decorated

Objects exported from other packages

Resolve Guide for Decorated Vector

Reduce Something to its Simplest Sufficient Version

parsimonious.default

Reduce by Default to Simplest Sufficient Version

semi_join.decorated

Semi_join Decorated

Identify Selected Names

Calculate Substitute Values

Render Scripted Attributes of Indicated Components

select.decorated

Select Decorated

selected.default

Identify Selected Names by Default

slice.decorated

Slice Decorated

Subset Unit String

Subset Decorated Vector

Choose Singular Expression

a <- as_decorated(as.list(setNames(letters[1:3], LETTERS[1:3]))) attr(a$B, 'label') <- 'foo' a <- a[1:3] attributes(a) Subset Decorated

Element-select Decorated Vector

[[<-.classified

Assign Element of Classified

to_yamlet.character

Coerce Character to Yamlet Storage Format

Assign Subset of Classified

Assign Element of Decorated Vector

Place Units Under Label

scale_type.dvec

Determine Scale Type for dvec

right_join.decorated

Right_join Decorated

Unclassify Something

unclassified.classified

Unclassify Classified

Assign Subset of Decorated

type_sum.classified

Summarize Type of Classified

to_yamlet.yamlet

Coerce Yamlet to Yamlet Storage Format

Element-select Unit String

Assign Element of Decorated

unclassified.data.frame

Unclassify Data Frame

Element-select Classified

ungroup.decorated

Ungroup Decorated

Collapse Uninformative Levels

to_yamlet.numeric

Coerce Numeric to Yamlet Storage Format

Coerce list to yamlet Storage Format

vec_cast.dvec.double

Cast to dvec from double

vec_cast.dvec.dvec

Cast to dvec from dvec

unclassified.dvec

Unclassify Decorated Vector

vec_cast.classified.classified

Cast to classified from classified

Subset Classified

vec_cast.factor.classified

Cast to factor from classified

vec_cast.dvec.character

Cast to dvec from character

Assign Subset of Decorated Vector

vec_cast.character.dvec

Cast to character from dvec

vec_ptype2.decorated.data.frame

Determine Common Type for Decorated and Data.frame

vec_ptype2.decorated.decorated

Determine Common Type for Decorated

vec_ptype2.complex.dvec

Find Common Type for complex, dvec

summarise.decorated

Summarise Decorated

vec_ptype2.classified.classified

Find Common Type for classified, classified

Coerce to Yamlet Storage Format

Collapse Uninformative Levels by Default

vec_ptype2.dvec.character

Find Common Type for dvec, dvec

vec_cast.complex.dvec

Cast to complex from dvec

vec_ptype2.dvec.complex

Find Common Type for dvec, complex

vec_cast.decorated.data.frame

Cast to Decorated from Data.frame

Enforce Symmetry

to_yamlet.default

Coerce Default to Yamlet Storage Format

summarize.decorated

Summarize Decorated

vec_cast.logical.dvec

Cast to logical from dvec

vec_cast.data.frame.decorated

Cast to Data.frame from Decorated

Element-select Decorated.

vec_ptype2.classified.factor

Find Common Type for classified, factor

Collapse Uninformative Levels of a List

vec_cast.classified.factor

Cast to classified from factor

vec_cast.dvec.logical

Cast to dvec from logical

vec_ptype2.data.frame.decorated

Determine Common Type for Data.frame and Decorated

vec_cast.integer.dvec

Cast to integer from dvec

yamlet: Versatile Curation of Table Metadata

xtable.decorated

Create Export Table for Decorated

vec_ptype2.dvec.integer

Find Common Type for dvec, integer

vec_ptype2.double.dvec

Find Common Type for double, dvec

vec_cast.dvec.complex

Cast to dvec from complex

vec_ptype2.dvec.logical

Find Common Type for dvec, logical

vec_ptype2.dvec.dvec

Find Common Type for dvec, dvec

vec_ptype2.dvec.double

Find Common Type for dvec, double

Coerce Null to Yamlet Storage Format

vec_cast.dvec.integer

Cast to dvec from integer

vec_ptype2.logical.dvec

Find Common Type for logical, dvec

vec_ptype2.integer.dvec

Find Common Type for integer, dvec

vec_ptype2.character.dvec

Find Common Type for character, dvec

vec_cast.double.dvec

Cast to double from dvec

vec_cast.decorated.decorated

Cast to Decorated from Decorated

vec_ptype_abbr.dvec

Abbreviate Decorated Vector

Display Global Yamlet Options

vec_ptype2.factor.classified

Find Common Type for factor, classified