Learn R Programming

yamlet (version 1.2.1)

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

485

Version

1.2.1

License

GPL-3

Maintainer

Tim Bergsma

Last Published

April 18th, 2025

Functions in yamlet (1.2.1)

as_dvec.integer

Coerce Integer to Decorated Vector

Coerce Units to Decorated Vector

as.character.yamlet

Coerce Yamlet to Character

as_unit_string.character

Coerce Character to Unit String

Coerce Decorated Vector to Decorated Vector

as_spork.symbolic_units

Coerce Symbolic Units to Spork

as_dvec.numeric

Coerce Numeric to Decorated Vector

as_dvec.complex

Coerce Complex to Decorated Vector

canonical.decorated

Sort Decorations

classified.factor

Create Classified from Factor

Coerce Decorated Vector to Units

as.integer.classified

Coerce Classified to Integer

as_unit_string.symbolic_units

Coerce Symbolic Units to Unit String.

as_spork.unit_string

Coerce Unit String to Spork

as_unit_string.factor

Coerce Factor to Unit String

classified.dvec

Classify Decorated Vector

as_dvec.logical

Coerce Logical to Decorated Vector

as.data.frame.dvec

Coerce Decorated Vector to Data Frame

Enforce Canonical Order

as.data.frame.yamlet

Coerce Yamlet to Data Frame

Combine Decorated Vector

Combine Classified

drop_title.dvec

Drop Title for Decorated Vector

Classify Something

decorate.data.frame

Decorate Data Frame

Conditionalize Attributes

filter.decorated

Filter Decorated

Footnote Something

Coerce Units to Spork

as_decorated.default

Coerce to Decorated by Default

Coerce to Decorated

decorate_groups.data.frame

Capture Groups as Decorations for Data Frame

conditionalize.data.frame

Conditionalize Attributes of Data Frame

as_yamlet.character

Coerce Character To Yamlet Format

Coerce to Yamlet

Desolve Guide for Decorated Vector

classified.classified

Create Classified from Classified

decorate_groups

Capture Groups as Decorations

canonical.yamlet

Prepare Data for GGplot

as_unit_string.units

Coerce Units to Unit String.

Coerce to Unit String

desolve.classified

Desolve Guide for Classified

ggready.data.frame

Prepare Data Frame for GGplot

footnote.decorated

Footnote Decorated

Format Decorated Vector

ggplot.decorated

Create a New ggplot for a Decorated Data Frame

Import and Export Documented Tables

Test if Class is dvec

as_yam.character

Coerce Character to Yam

implicit_guide.data.frame

Coerce Data Frame Guide to Something More Implicit

io_table.character

Import Documented Table

io_yamlet.data.frame

Export Data Frame Attributes as Yamlet

Infer Type of Guide

ggplot_add.ggplot_isometric

Add Isometry to Plot Object

io_res.decorated

Export Resolved Table

Coerce Yamlet to Yam

Coerce Guide to Something More Implicit

io_table.data.frame

Export Documented Table

Check Parseable as Units

implicit_guide.dvec

Coerce Decorated Vector Guide to Something More Implicit

is_parseable.default

Check Something is Parseable as Units by Default

Evaluate Named Arguments

Enforce Isometry

make_title.decorated

Make Title for Decorated

io_yamlet.yamlet

names<-.decorated

Assign Names of Decorated

Calculate a Cell Value

decorations_groups.data.frame

Recover Groups Decorations for Data Frame

Detect Revised Label Strategy

Coerce List to Yamlet

explicit_guide.data.frame

Coerce Data Frame Guide to Something More Explicit

Coerce Yam To Yamlet Format

Coerce Guide to Something More Explicit

Promote Something

drop_title.decorated

Drop Title for Decorated

decorations_groups

Recover Groups Decorations

Decorate a List-like Object

Reduce Something to its Simplest Sufficient Version

as_yamlet.yamlet

Coerce Yamlet to Yamlet

ggready.decorated

Prepare Decorated Data Frame for GGplot

Coerce Data.frame to Decorated

drop_title.default

Drop Title by Default

decorate.character

Decorate Character

enscript.default

Render Scripted Attributes of Indicated Components by Default

Coerce Common Type to Decorated

Render Scripted Attributes of Indicated Components

make_title.default

Make Title by Default

group_by.decorated

Group_by Decorated

Import and Export Resolved Tables

as_yamlet.data.frame

Coerce Data Frame to Yamlet

Reconcile Atttributes

Test Object is Conditional

desolve.decorated

Desolve Guide for Decorated

classified.default

Create Classified by Default

decorations.data.frame

Retrieve Decorations for Data Frame

Retrieve Decorations

desolve.data.frame

Desolve Data Frame

classified.data.frame

Classify Data Frame

group_by_decorations.data.frame

Groups by Decorations for Data Frame

promote.data.frame

Promote Data Frame

io_res.character

Import Documented Table as Resolved

explicit_guide.dvec

Coerce Decorated Vector Guide to Something More Explicit

io_csv.data.frame

Export Documented Table as CSV

group_by_decorations

Group by Decorations

explicit_guide.yamlet

Coerce Yamlet Guide to Something More Explicit

gather.decorated

Gather a Decorated Data Frame

io_csv.character

Import Documented Table as CSV

parsimonious.default

Reduce by Default to Simplest Sufficient Version

ggplot_add.ggplot_symmetric

Add Symmetry to Plot Object

promote.default

Promote by Default

full_join.decorated

Full_join Decorated

isConditional.default

Test Object is Conditional by Default

Coerce List to Encoding

isLevels.character

Test Character Value is Levels

Try To Look Like Another Equal-length Variable

left_join.decorated

Left_join Decorated

Get Length of a Decorated Vector

print.decorated_ggplot

Substitute Expressions, Titles, Labels and Aesthetics in ggplots

Modify Attributes of Indicated Components by Default

isLevels.default

Test Value is Levels by Default

parsimonious.list

Reduce A List to its Simplest Sufficient Version

merge.decorated

Merge Decorated

make_title.dvec

Make Title for Decorated Vector

Calculate Substitute Values for Factor Levels

print.decorated_xtable

Print Decorated Xtable

Print Decorated Vector

mutate.decorated

Mutate Decorated

semi_join.decorated

Semi_join Decorated

Modify Attributes of Indicated Components

Element-select Classified

Choose Singular Expression

resolve.classified

Resolve Classified

resolve.decorated

Resolve Guide for Decorated

unclassified.classified

Unclassify Classified

Unclassify Something

Assign Subset of Classified

Reconcile Atttributes of List Members

Element-select Decorated.

Assign Subset of Decorated Vector

slice.decorated

Slice Decorated

summarise.decorated

Summarise Decorated

Subset Classified

to_yamlet.yamlet

Coerce Yamlet to Yamlet Storage Format

vec_cast.double.dvec

Cast to double from dvec

vec_cast.decorated.decorated

Cast to Decorated from Decorated

resolve.data.frame

Resolve Data Frame

Assign Subset of Decorated

Resolve Guide for Decorated Vector

vec_cast.classified.factor

Cast to classified from factor

type_sum.classified

Summarize Type of Classified

summarize.decorated

Summarize Decorated

ggplot_build.decorated_ggplot

Enable Automatic Labels and Units for ggplot

Element-select Decorated Vector

Element-select Unit String

right_join.decorated

Right_join Decorated

scale_type.dvec

Determine Scale Type for dvec

Import and Export Documented Tables as CSV

inner_join.decorated

Inner_join Decorated

Import and Export Yamlet

Test Value is Levels

mimic.classified

Try To Make Classified Look Like Another Equal-length Variable

isConditional.list

Test List is Conditional

Try To Look Like Something Else

Calculate Substitute Values

io_yamlet.character

Redecorate a List-like Object

Objects exported from other packages

Identify Selected Names

[[<-.classified

Assign Element of Classified

Assign Element of Decorated

selected.default

Identify Selected Names by Default

Assign Element of Decorated Vector

Place Units Under Label

Subset Decorated Vector

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

Enforce Symmetry

vec_cast.character.dvec

Cast to character from dvec

Coerce Null to Yamlet Storage Format

Coerce to Yamlet Storage Format

Collapse Uninformative Levels by Default

Render Scripted Attributes of Indicated Components

select.decorated

Select Decorated

Subset Unit String

Coerce list to yamlet Storage Format

vec_ptype2.complex.dvec

Find Common Type for complex, dvec

vec_cast.classified.classified

Cast to classified from classified

vec_cast.logical.dvec

Cast to logical from dvec

vec_ptype2.character.dvec

Find Common Type for character, dvec

to_yamlet.numeric

Coerce Numeric to Yamlet Storage Format

vec_ptype2.dvec.dvec

Find Common Type for dvec, dvec

Collapse Uninformative Levels of a List

vec_cast.dvec.double

Cast to dvec from double

vec_cast.complex.dvec

Cast to complex from dvec

vec_ptype2.dvec.integer

Find Common Type for dvec, integer

vec_cast.data.frame.decorated

Cast to Data.frame from Decorated

vec_ptype2.factor.classified

Find Common Type for factor, classified

vec_ptype2.data.frame.decorated

Determine Common Type for Data.frame and Decorated

vec_ptype2.dvec.logical

Find Common Type for dvec, logical

unclassified.dvec

Unclassify Decorated Vector

unclassified.data.frame

Unclassify Data Frame

to_yamlet.default

Coerce Default to Yamlet Storage Format

ungroup.decorated

Ungroup Decorated

vec_ptype2.integer.dvec

Find Common Type for integer, dvec

vec_ptype2.logical.dvec

Find Common Type for logical, dvec

vec_ptype_abbr.dvec

Abbreviate Decorated Vector

vec_cast.decorated.data.frame

Cast to Decorated from Data.frame

Display Global Yamlet Options

to_yamlet.character

Coerce Character to Yamlet Storage Format

vec_cast.integer.dvec

Cast to integer from dvec

vec_cast.factor.classified

Cast to factor from classified

vec_cast.dvec.dvec

Cast to dvec from dvec

vec_cast.dvec.complex

Cast to dvec from complex

vec_cast.dvec.character

Cast to dvec from character

Collapse Uninformative Levels

vec_cast.dvec.integer

Cast to dvec from integer

vec_ptype2.decorated.decorated

Determine Common Type for Decorated

vec_ptype2.decorated.data.frame

Determine Common Type for Decorated and Data.frame

vec_ptype2.double.dvec

Find Common Type for double, dvec

vec_cast.dvec.logical

Cast to dvec from logical

vec_ptype2.classified.classified

Find Common Type for classified, classified

vec_ptype2.classified.factor

Find Common Type for classified, factor

yamlet: Versatile Curation of Table Metadata

vec_ptype2.dvec.character

Find Common Type for dvec, dvec

xtable.decorated

Create Export Table for Decorated

vec_ptype2.dvec.complex

Find Common Type for dvec, complex

vec_ptype2.dvec.double

Find Common Type for dvec, double

arbitrate.default

Arbitrate Default

alias.data.frame

Alias a Data Frame

append_units.data.frame

Append Units for Data Frame

anti_join.decorated

Anti_join Decorated

Arbitrate Two Attributes

append_units.default

Append Units By Default

arbitrate.namedList

Arbitrate Named List

as_dvec.character

Coerce Character to Decorated Vector

Coerce to Decorated Vector

arrange.decorated

Arrange Decorated

as.character.yam

Coerce Yam to Character