Learn R Programming

yamlet (version 1.5.0)

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

1,018

Version

1.5.0

License

GPL-3

Maintainer

Tim Bergsma

Last Published

November 7th, 2026

Functions in yamlet (1.5.0)

as_decorated

Coerce to Decorated
as.character.yamlet

Coerce Yamlet to Character
as.data.frame.yamlet

Coerce Yamlet to Data Frame
arrange.decorated

Arrange Decorated
as.data.frame.dvec

Coerce Decorated Vector to Data Frame
as_categorical.decorated

Coerce decorated to Categorical
as_categorical

Coerce to Categorical
as.integer.classified

Coerce Classified to Integer
as_decorated.default

Coerce to Decorated by Default
as.character.yam

Coerce Yam to Character
as_spork.unit_string

Coerce Unit String to Spork
as_dvec.units

Coerce Units to Decorated Vector
as_spork.symbolic_units

Coerce Symbolic Units to Spork
as_dvec.complex

Coerce Complex to Decorated Vector
as_dvec.dvec

Coerce Decorated Vector to Decorated Vector
as_dvec.logical

Coerce Logical to Decorated Vector
as_dvec.integer

Coerce Integer to Decorated Vector
as_dvec.numeric

Coerce Numeric to Decorated Vector
as_dvec

Coerce to Decorated Vector
as_dvec.character

Coerce Character to Decorated Vector
as_yam.character

Coerce Character to Yam
as_unit_string

Coerce to Unit String
as_yam.yamlet

Coerce Yamlet to Yam
as_unit_string.factor

Coerce Factor to Unit String
as_unit_string.symbolic_units

Coerce Symbolic Units to Unit String.
as_units.dvec

Coerce Decorated Vector to Units
canonical.decorated

Sort Decorations
as_yamlet.yam

Coerce Yam To Yamlet Format
as_yamlet

Coerce to Yamlet
as_unit_string.character

Coerce Character to Unit String
as_yamlet.yamlet

Coerce Yamlet to Yamlet
c.dvec

Combine Decorated Vector
as_unit_string.units

Coerce Units to Unit String.
as_yamlet.data.frame

Coerce Data Frame to Yamlet
as_yamlet.list

Coerce List to Yamlet
canonical

Enforce Canonical Order
as_spork.units

Coerce Units to Spork
c.classified

Combine Classified
as_yam

Coerce to Yam
classified.factor

Create Classified from Factor
classified.data.frame

Classify Data Frame
as_yamlet.character

Coerce Character To Yamlet Format
classified.default

Create Classified by Default
codify

Convert to Codes
canonical.yamlet

Sort Yamlet
cell_value

Calculate a Cell Value
codify.default

Convert to Codes by Default
classified.dvec

Classify Decorated Vector
classified

Classify Something
classified.classified

Create Classified from Classified
dd_ptype2

Coerce Common Type to Decorated
conditionalize.data.frame

Conditionalize Attributes of Data Frame
decorate.character

Decorate Character
decorate.data.frame

Decorate Data Frame
data_context.ggplot

Retrieve Data Context of ggplot
decorate

Decorate a List-like Object
dd_cast

Coerce Data.frame to Decorated
decorate.list

Decorate List
conditionalize

Conditionalize Attributes
data_context

Retrieve Data Context
desolve.decorated

Desolve Guide for Decorated
decorations

Retrieve Decorations
desolve.classified

Desolve Guide for Classified
decorations.data.frame

Retrieve Decorations for Data Frame
decorations_groups.data.frame

Recover Groups Decorations for Data Frame
decorate_groups.data.frame

Capture Groups as Decorations for Data Frame
desolve.data.frame

Desolve Data Frame
desolve

Desolve Guide
decorate_groups

Capture Groups as Decorations
decorations_groups

Recover Groups Decorations
desolve.default

Desolve Default
enscript.decorated

Render Scripted Attributes of Indicated Components by Default
enscript.data.frame

Enscript Data Frame
enscript

Render Scripted Attributes of Indicated Components
desolve.dvec

Desolve Guide for Decorated Vector
drop_title.default

Drop Title by Default
drop_title.dvec

Drop Title for Decorated Vector
drop_title.decorated

Drop Title for Decorated
encode.yamlet

Encode Yamlet
drop_title

Drop Title
enscript.default

Enscript Default
explicit_guide.yamlet

Coerce Yamlet Guide to Something More Explicit
explicit_guide.dvec

Coerce Decorated Vector Guide to Something More Explicit
explicit_guide.factor

Coerce Factor Guide to Something More Explicit
filter.decorated

Filter Decorated
footnote

Footnote Something
explicit_guide.data.frame

Coerce Data Frame Guide to Something More Explicit
explicit_guide

Coerce Guide to Something More Explicit
format.dvec

Format Decorated Vector
footnote.decorated

Footnote Decorated
get_labs

Get Labels
ggready.data.frame

Prepare Data Frame for GGplot
ggplot_add.ggplot_symmetric

Add Symmetry to Plot Object
gg_new

Detect Revised Label Strategy
ggplot.decorated

Create a New ggplot for a Decorated Data Frame
ggready

Prepare Data for GGplot
full_join.decorated

Full_join Decorated
ggplot_add.ggplot_isometric

Add Isometry to Plot Object
gather.decorated

Gather a Decorated Data Frame
ggplot_build.decorated_ggplot

Substitute Expressions, Titles, Labels and Aesthetics in ggplots
infer_guide

Infer Type of Guide
inner_join.decorated

Inner_join Decorated
group_by_decorations.data.frame

Groups by Decorations for Data Frame
implicit_guide.data.frame

Coerce Data Frame Guide to Something More Implicit
implicit_guide

Coerce Guide to Something More Implicit
implicit_guide.factor

Coerce Factor Guide to Something More Implicit
implicit_guide.dvec

Coerce Decorated Vector Guide to Something More Implicit
group_by.decorated

Group_by Decorated
group_by_decorations

Group by Decorations
ggready.decorated

Prepare Decorated Data Frame for GGplot
io_res

Import and Export Resolved Tables
io_table

Import and Export Documented Tables
io_csv

Import and Export Documented Tables as CSV
io_yamlet

Import and Export Yamlet
io_table.character

Import Documented Table
io_res.decorated

Export Resolved Table
io_csv.data.frame

Export Documented Table as CSV
io_csv.character

Import Documented Table as CSV
io_table.data.frame

Export Documented Table
io_res.character

Import Documented Table as Resolved
isLevels

Test Value is Levels
is_dvec

Test if Class is dvec
isConditional.default

Test Object is Conditional by Default
isLevels.character

Test Character Value is Levels
io_yamlet.yamlet

Export Yamlet
isLevels.default

Test Value is Levels by Default
isConditional.list

Test List is Conditional
isConditional

Test Object is Conditional
list2encoding

Coerce List to Encoding
isometric

Enforce Isometry
make_title

Make Title
io_yamlet.character

Import Yamlet
io_yamlet.data.frame

Export Data Frame Attributes as Yamlet
make_title.default

Make Title by Default
is_parseable

Check Parseable as Units
is_parseable.default

Check Something is Parseable as Units by Default
length.dvec

Get Length of a Decorated Vector
make_title.dvec

Make Title for Decorated Vector
make_title.decorated

Make Title for Decorated
left_join.decorated

Left_join Decorated
mapframe.ggplot

Coerce ggplot Mappings to Dataframe
mutate.decorated

Mutate Decorated
mimic.classified

Try To Make Classified Look Like Another Equal-length Variable
mapframe

Coerce Mapping to Dataframe
mapframe.default

Coerce ggplot Mapping to Dataframe
modify.default

Modify Attributes of Indicated Components by Default
mimic.default

Try To Look Like Another Equal-length Variable
merge.decorated

Merge Decorated
mimic

Try To Look Like Something Else
modify

Modify Attributes of Indicated Components
promote

Promote Something
parsimonious

Reduce Something to its Simplest Sufficient Version
parsimonious.list

Reduce A List to its Simplest Sufficient Version
named

Evaluate Named Arguments
print.dvec

Print Decorated Vector
names<-.decorated

Assign Names of Decorated
parsimonious.default

Reduce by Default to Simplest Sufficient Version
print.decorated_xtable

Print Decorated Xtable
promote.data.frame

Promote Data Frame
print.yamlet

Print a Yamlet
read_yamlet

Read Yamlet
reexports

Objects exported from other packages
promote.default

Promote by Default
proxy

Calculate Substitute Values
rescale.dvec

Rescale dvec
reconcile.list

Reconcile Atttributes of List Members
proxy.factor

Calculate Substitute Values for Factor Levels
reconcile

Reconcile Atttributes
promote.list

Promote a List
redecorate

Redecorate a List-like Object
resolve.decorated

Resolve Guide for Decorated
resolve.dvec

Resolve Guide for Decorated Vector
resolve.default

Resolve Default
scale_type.dvec

Determine Scale Type for dvec
resolve

Resolve Guide
resolve.data.frame

Resolve Data Frame
right_join.decorated

Right_join Decorated
scripted

Render Scripted Attributes of Indicated Components
resolve.factor

Resolve Guide for Factor
resolve.classified

Resolve Classified
select.decorated

Select Decorated
singularity

Choose Singular Expression
selected.default

Identify Selected Names by Default
[.decorated

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
selected

Identify Selected Names
[.classified

Subset Classified
slice.decorated

Slice Decorated
[[.unit_string

Element-select Unit String
[.yamlet

Subset Yamlet
[<-.classified

Assign Subset of Classified
semi_join.decorated

Semi_join Decorated
sub_units

Place Units Under Label
[[<-.dvec

Assign Element of Decorated Vector
[[<-.decorated

Assign Element of Decorated
[[<-.classified

Assign Element of Classified
[[.decorated

Element-select Decorated.
[.dvec

Subset Decorated Vector
[.unit_string

Subset Unit String
[[.dvec

Element-select Decorated Vector
[[.classified

Element-select Classified
[<-.dvec

Assign Subset of Decorated Vector
to_yamlet.list

Coerce list to yamlet Storage Format
summarize.decorated

Summarize Decorated
to_yamlet.character

Coerce Character to Yamlet Storage Format
to_yamlet

Coerce to Yamlet Storage Format
to_yamlet.NULL

Coerce Null to Yamlet Storage Format
symmetric

Enforce Symmetry
summarise.decorated

Summarise Decorated
[<-.decorated

Assign Subset of Decorated
to_yamlet.default

Coerce Default to Yamlet Storage Format
undecorate.default

Undecorate by Default
to_yamlet.numeric

Coerce Numeric to Yamlet Storage Format
ungroup.decorated

Ungroup Decorated
unclassified.classified

Unclassify Classified
type_sum.classified

Summarize Type of Classified
to_yamlet.yamlet

Coerce Yamlet to Yamlet Storage Format
unclassified.dvec

Unclassify Decorated Vector
vec_cast.classified.classified

Cast to classified from classified
vec_cast.data.frame.decorated

Cast to Data.frame from Decorated
unnest.default

Collapse Uninformative Levels by Default
unclassified.data.frame

Unclassify Data Frame
unclassified

Unclassify Something
unnest.list

Collapse Uninformative Levels of a List
vec_cast.character.dvec

Cast to character from dvec
unnest

Collapse Uninformative Levels
vec_cast.complex.dvec

Cast to complex from dvec
vec_cast.classified.factor

Cast to classified from factor
undecorate

Undecorate Something
vec_cast.decorated.data.frame

Cast to Decorated from Data.frame
vec_cast.decorated.decorated

Cast to Decorated from Decorated
vec_ptype2.dvec.character

Find Common Type for dvec, character
vec_cast.dvec.integer

Cast to dvec from integer
vec_ptype2.decorated.data.frame

Determine Common Type for Decorated and Data.frame
vec_ptype2.character.dvec

Find Common Type for character, dvec
vec_cast.logical.dvec

Cast to logical from dvec
vec_cast.factor.classified

Cast to factor from classified
vec_cast.double.dvec

Cast to double from dvec
vec_cast.dvec.double

Cast to dvec from double
vec_cast.dvec.dvec

Cast to dvec from dvec
vec_cast.integer.dvec

Cast to integer from dvec
vec_cast.dvec.logical

Cast to dvec from logical
vec_cast.dvec.complex

Cast to dvec from complex
vec_ptype2.double.dvec

Find Common Type for double, dvec
vec_ptype2.data.frame.decorated

Determine Common Type for Data.frame and Decorated
vec_cast.dvec.character

Cast to dvec from character
vec_ptype2.decorated.decorated

Determine Common Type for Decorated
vec_ptype2.classified.classified

Find Common Type for classified, classified
write_yamlet

Write Yamlet
vec_ptype2.complex.dvec

Find Common Type for complex, dvec
vec_ptype2.dvec.double

Find Common Type for dvec, double
vec_ptype2.dvec.complex

Find Common Type for dvec, complex
vec_ptype2.logical.dvec

Find Common Type for logical, dvec
vec_ptype2.classified.factor

Find Common Type for classified, factor
vec_ptype2.integer.dvec

Find Common Type for integer, dvec
vec_ptype2.dvec.integer

Find Common Type for dvec, integer
vec_ptype2.factor.classified

Find Common Type for factor, classified
yamlet_options

Display Global Yamlet Options
yamlet

yamlet: Versatile Curation of Table Metadata
vec_ptype_abbr.dvec

Abbreviate Decorated Vector
vec_ptype2.dvec.dvec

Find Common Type for dvec, dvec
xtable.decorated

Create Export Table for Decorated
vec_ptype2.dvec.logical

Find Common Type for dvec, logical
arbitrate

Arbitrate Two Attributes
anti_join.decorated

Anti_join Decorated
arbitrate.namedList

Arbitrate Named List
arbitrate.NULL

Arbitrate Null
alias.data.frame

Alias a Data Frame
append_units

Append Units
append_units.default

Append Units By Default
append_units.data.frame

Append Units for Data Frame
arbitrate.list

Arbitrate List
arbitrate.default

Arbitrate Default