ScaleList: Mutable List of Scale objects

In paleolimbot/ggr6: An Implementaation of the Grammar of Graphics in R6

Description

ScaleList objects contain a list of Scales, and have methods that can perform the same operation on all the scales they contain. They currently also generate the GuideList of trained Guides based on the Scales they contain.

Super class

ggr6::List -> ScaleList

Methods

Public methods

• ScaleList$set()

• ScaleList$aesthetics()

• ScaleList$scale()

• ScaleList$guides()

• ScaleList$filter_by_aesthetics()

• ScaleList$discard_by_aesthetics()

• ScaleList$transform_tbl()

• ScaleList$untransform_tbl()

• ScaleList$train_tbl()

• ScaleList$reset()

• ScaleList$map_tbl()

• ScaleList$add_missing()

• ScaleList$clone()

Inherited methods

• ggr6::List$add()

• ggr6::List$get()

• ggr6::List$initialize()

• ggr6::List$size()

---

Method set()

Usage

ScaleList$set(index, item)

---

Method aesthetics()

Usage

ScaleList$aesthetics()

Details

A character vector of aesthetics represented by the Scales within the list.

---

Method scale()

Usage

ScaleList$scale(aesthetic, default = NULL)

Details

Extract a scale by aesthetic (returning default if there is none.)

---

Method guides()

Usage

ScaleList$guides()

Details

Returns a GuideList of Guides extracted and trained from the Scales within the object.

---

Method filter_by_aesthetics()

Usage

ScaleList$filter_by_aesthetics(aesthetics)

Details

Return a new ScaleList containing any scale representing one or more aesthetics specified.

---

Method discard_by_aesthetics()

Usage

ScaleList$discard_by_aesthetics(aesthetics)

Details

Return a new ScaleList containing any scale that does not represent the aesthetics specified.

---

Method transform_tbl()

Usage

ScaleList$transform_tbl(data)

Details

Calls the $transform_tbl() method for each Scale iteratively, returning the result.

---

Method untransform_tbl()

Usage

ScaleList$untransform_tbl(data)

Details

Calls the $untransform_tbl() method for each Scale iteratively, returning the result.

---

Method train_tbl()

Usage

ScaleList$train_tbl(data_trans)

Details

Calls the $transform_tbl() method for each Scale. Calls the $reset() method for each Scale iteratively, returning the result.

---

Method reset()

Usage

ScaleList$reset()

---

Method map_tbl()

Usage

ScaleList$map_tbl(data_trans)

Details

Calls the $map_tbl() method for each Scale iteratively, returning the result.

---

Method add_missing()

Usage

ScaleList$add_missing(data, renderer)

Details

Add missing scales to this object based on data (whose names are aesthetics) and the Renderer.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ScaleList$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

paleolimbot/ggr6 documentation built on Feb. 5, 2020, 2:17 p.m.