Learn R Programming

yamlet (version 1.3.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

221

Version

1.3.2

License

GPL-3

Maintainer

Tim Bergsma

Last Published

January 16th, 2026

Functions in yamlet (1.3.2)

as_categorical

Coerce to Categorical
as_yamlet

Coerce to Yamlet
classified.factor

Create Classified from Factor
as_spork.units

Coerce Units to Spork
as_dvec

Coerce to Decorated Vector
as_unit_string

Coerce to Unit String
as_yamlet.character

Coerce Character To Yamlet Format
classified.dvec

Classify Decorated Vector
as.integer.classified

Coerce Classified to Integer
as_decorated

Coerce to Decorated
decorate_groups.data.frame

Capture Groups as Decorations for Data Frame
as_yam.character

Coerce Character to Yam
decorate.list

Decorate List
as.data.frame.yamlet

Coerce Yamlet to Data Frame
decorate_groups

Capture Groups as Decorations
as_unit_string.symbolic_units

Coerce Symbolic Units to Unit String.
classified

Classify Something
as_dvec.units

Coerce Units to Decorated Vector
decorate.data.frame

Decorate Data Frame
as_unit_string.units

Coerce Units to Unit String.
classified.classified

Create Classified from Classified
desolve.decorated

Desolve Guide for Decorated
drop_title.default

Drop Title by Default
format.dvec

Format Decorated Vector
footnote.decorated

Footnote Decorated
drop_title.dvec

Drop Title for Decorated Vector
explicit_guide.data.frame

Coerce Data Frame Guide to Something More Explicit
desolve.data.frame

Desolve Data Frame
desolve.dvec

Desolve Guide for Decorated Vector
as_dvec.character

Coerce Character to Decorated Vector
as_yam.yamlet

Coerce Yamlet to Yam
desolve.default

Desolve Default
c.classified

Combine Classified
as_categorical.decorated

Coerce decorated to Categorical
as_decorated.default

Coerce to Decorated by Default
c.dvec

Combine Decorated Vector
as_dvec.logical

Coerce Logical to Decorated Vector
as_dvec.integer

Coerce Integer to Decorated Vector
classified.default

Create Classified by Default
enscript.default

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

Retrieve Decorations for Data Frame
as_yam

Coerce to Yam
explicit_guide.dvec

Coerce Decorated Vector Guide to Something More Explicit
as_unit_string.factor

Coerce Factor to Unit String
decorations

Retrieve Decorations
filter.decorated

Filter Decorated
as_unit_string.character

Coerce Character to Unit String
as_yamlet.data.frame

Coerce Data Frame to Yamlet
classified.data.frame

Classify Data Frame
as_units.dvec

Coerce Decorated Vector to Units
ggplot_add.ggplot_symmetric

Add Symmetry to Plot Object
footnote

Footnote Something
canonical

Enforce Canonical Order
get_labs

Get Labels
explicit_guide

Coerce Guide to Something More Explicit
ggready.decorated

Prepare Decorated Data Frame for GGplot
decorate

Decorate a List-like Object
as_yamlet.yam

Coerce Yam To Yamlet Format
group_by.decorated

Group_by Decorated
as_yamlet.yamlet

Coerce Yamlet to Yamlet
implicit_guide.dvec

Coerce Decorated Vector Guide to Something More Implicit
io_table

Import and Export Documented Tables
group_by_decorations.data.frame

Groups by Decorations for Data Frame
gg_new

Detect Revised Label Strategy
group_by_decorations

Group by Decorations
desolve

Desolve Guide
parsimonious

Reduce Something to its Simplest Sufficient Version
io_table.character

Import Documented Table
decorate.character

Decorate Character
infer_guide

Infer Type of Guide
cell_value

Calculate a Cell Value
ggplot_build.decorated_ggplot

Substitute Expressions, Titles, Labels and Aesthetics in ggplots
canonical.yamlet

Sort Yamlet
inner_join.decorated

Inner_join Decorated
as_yamlet.list

Coerce List to Yamlet
canonical.decorated

Sort Decorations
implicit_guide.factor

Coerce Factor Guide to Something More Implicit
io_yamlet.yamlet

Export Yamlet
data_context

Retrieve Data Context
parsimonious.default

Reduce by Default to Simplest Sufficient Version
conditionalize

Conditionalize Attributes
desolve.classified

Desolve Guide for Classified
dd_cast

Coerce Data.frame to Decorated
conditionalize.data.frame

Conditionalize Attributes of Data Frame
dd_ptype2

Coerce Common Type to Decorated
mapframe.default

Coerce ggplot Mapping to Dataframe
mapframe

Coerce Mapping to Dataframe
enscript

Render Scripted Attributes of Indicated Components
is_parseable.default

Check Something is Parseable as Units by Default
is_parseable

Check Parseable as Units
encode.yamlet

Encode Yamlet
isConditional

Test Object is Conditional
io_csv.data.frame

Export Documented Table as CSV
is_dvec

Test if Class is dvec
make_title.default

Make Title by Default
io_yamlet.character

Import Yamlet
make_title.dvec

Make Title for Decorated Vector
io_yamlet.data.frame

Export Data Frame Attributes as Yamlet
isLevels.default

Test Value is Levels by Default
promote.default

Promote by Default
io_table.data.frame

Export Documented Table
io_res

Import and Export Resolved Tables
mimic

Try To Look Like Something Else
mimic.default

Try To Look Like Another Equal-length Variable
data_context.ggplot

Retrieve Data Context of ggplot
print.dvec

Print Decorated Vector
mimic.classified

Try To Make Classified Look Like Another Equal-length Variable
parsimonious.list

Reduce A List to its Simplest Sufficient Version
modify

Modify Attributes of Indicated Components
read_yamlet

Read Yamlet
sub_units

Place Units Under Label
slice.decorated

Slice Decorated
reconcile

Reconcile Atttributes
semi_join.decorated

Semi_join Decorated
print.decorated_xtable

Print Decorated Xtable
[<-.classified

Assign Subset of Classified
drop_title

Drop Title
explicit_guide.factor

Coerce Factor Guide to Something More Explicit
selected.default

Identify Selected Names by Default
drop_title.decorated

Drop Title for Decorated
singularity

Choose Singular Expression
explicit_guide.yamlet

Coerce Yamlet Guide to Something More Explicit
io_yamlet

Import and Export Yamlet
reconcile.list

Reconcile Atttributes of List Members
redecorate

Redecorate a List-like Object
print.yamlet

Print a Yamlet
ggplot.decorated

Create a New ggplot for a Decorated Data Frame
type_sum.classified

Summarize Type of Classified
vec_cast.decorated.data.frame

Cast to Decorated from Data.frame
unnest

Collapse Uninformative Levels
scale_type.dvec

Determine Scale Type for dvec
promote.list

Promote a List
decorations_groups

Recover Groups Decorations
scripted

Render Scripted Attributes of Indicated Components
unnest.default

Collapse Uninformative Levels by Default
ggplot_add.ggplot_isometric

Add Isometry to Plot Object
unclassified

Unclassify Something
[<-.dvec

Assign Subset of Decorated Vector
to_yamlet

Coerce to Yamlet Storage Format
left_join.decorated

Left_join Decorated
[<-.decorated

Assign Subset of Decorated
vec_cast.decorated.decorated

Cast to Decorated from Decorated
[[.decorated

Element-select Decorated.
isometric

Enforce Isometry
decorations_groups.data.frame

Recover Groups Decorations for Data Frame
full_join.decorated

Full_join Decorated
mapframe.ggplot

Coerce ggplot Mappings to Dataframe
[[.dvec

Element-select Decorated Vector
io_csv

Import and Export Documented Tables as CSV
summarize.decorated

Summarize Decorated
summarise.decorated

Summarise Decorated
ggready

Prepare Data for GGplot
io_res.character

Import Documented Table as Resolved
io_res.decorated

Export Resolved Table
isConditional.default

Test Object is Conditional by Default
io_csv.character

Import Documented Table as CSV
isConditional.list

Test List is Conditional
length.dvec

Get Length of a Decorated Vector
named

Evaluate Named Arguments
resolve.data.frame

Resolve Data Frame
names<-.decorated

Assign Names of Decorated
unnest.list

Collapse Uninformative Levels of a List
to_yamlet.character

Coerce Character to Yamlet Storage Format
vec_cast.character.dvec

Cast to character from dvec
list2encoding

Coerce List to Encoding
proxy

Calculate Substitute Values
merge.decorated

Merge Decorated
gather.decorated

Gather a Decorated Data Frame
undecorate.default

Undecorate by Default
implicit_guide

Coerce Guide to Something More Implicit
vec_ptype2.decorated.decorated

Determine Common Type for Decorated
ggready.data.frame

Prepare Data Frame for GGplot
implicit_guide.data.frame

Coerce Data Frame Guide to Something More Implicit
isLevels

Test Value is Levels
proxy.factor

Calculate Substitute Values for Factor Levels
vec_ptype2.double.dvec

Find Common Type for double, dvec
resolve.decorated

Resolve Guide for Decorated
resolve.default

Resolve Default
reexports

Objects exported from other packages
resolve.dvec

Resolve Guide for Decorated Vector
rescale.dvec

Rescale dvec
select.decorated

Select Decorated
[.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
[[<-.decorated

Assign Element of Decorated
[.yamlet

Subset Yamlet
to_yamlet.numeric

Coerce Numeric to Yamlet Storage Format
[[<-.dvec

Assign Element of Decorated Vector
[[.classified

Element-select Classified
[.classified

Subset Classified
symmetric

Enforce Symmetry
selected

Identify Selected Names
yamlet

yamlet: Versatile Curation of Table Metadata
make_title

Make Title
make_title.decorated

Make Title for Decorated
vec_cast.dvec.complex

Cast to dvec from complex
to_yamlet.NULL

Coerce Null to Yamlet Storage Format
isLevels.character

Test Character Value is Levels
vec_ptype2.character.dvec

Find Common Type for character, dvec
unclassified.dvec

Unclassify Decorated Vector
ungroup.decorated

Ungroup Decorated
vec_cast.complex.dvec

Cast to complex from dvec
to_yamlet.yamlet

Coerce Yamlet to Yamlet Storage Format
vec_ptype2.data.frame.decorated

Determine Common Type for Data.frame and Decorated
vec_ptype2.classified.classified

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

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

Determine Common Type for Decorated and Data.frame
vec_ptype2.factor.classified

Find Common Type for factor, classified
yamlet_options

Display Global Yamlet Options
vec_cast.classified.classified

Cast to classified from classified
undecorate

Undecorate Something
vec_cast.classified.factor

Cast to classified from factor
vec_ptype2.dvec.logical

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

Cast to dvec from dvec
vec_cast.dvec.integer

Cast to dvec from integer
vec_ptype2.dvec.integer

Find Common Type for dvec, integer
modify.default

Modify Attributes of Indicated Components by Default
mutate.decorated

Mutate Decorated
vec_cast.data.frame.decorated

Cast to Data.frame from Decorated
vec_cast.dvec.double

Cast to dvec from double
vec_cast.factor.classified

Cast to factor from classified
vec_ptype2.dvec.complex

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

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

Cast to logical from dvec
vec_cast.dvec.logical

Cast to dvec from logical
vec_cast.integer.dvec

Cast to integer from dvec
write_yamlet

Write Yamlet
vec_ptype2.dvec.double

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

Find Common Type for dvec, dvec
xtable.decorated

Create Export Table for Decorated
promote

Promote Something
promote.data.frame

Promote Data Frame
right_join.decorated

Right_join Decorated
[.unit_string

Subset Unit String
resolve.classified

Resolve Classified
resolve

Resolve Guide
resolve.factor

Resolve Guide for Factor
[.dvec

Subset Decorated Vector
[[<-.classified

Assign Element of Classified
[[.unit_string

Element-select Unit String
unclassified.classified

Unclassify Classified
to_yamlet.default

Coerce Default to Yamlet Storage Format
unclassified.data.frame

Unclassify Data Frame
to_yamlet.list

Coerce list to yamlet Storage Format
vec_ptype2.complex.dvec

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

Cast to double from dvec
vec_cast.dvec.character

Cast to dvec from character
vec_ptype2.classified.factor

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

Find Common Type for logical, dvec
vec_ptype_abbr.dvec

Abbreviate Decorated Vector