pipe_label_factors: Label factors

In stevepowell99/CausalMapFunctions: Functions for Causal Mapping

Label factors

Description

For example it is possible to add the factor frequency to the factor labels. More than one label can be added: Labels are additive and are applied one after the other. Other formatting commands such as factor and link colour can either specify a fixed colour ('links colour blue') or can be used conditionally, so that a the colour or transparency of links can depend on any custom field existing in the original data such as, say, 'gender' but also on fields created by the app e.g. frequency.

Usage

pipe_label_factors(
  graf,
  field = "frequency",
  clear_previous = F,
  add_field_name = T,
  clear = clear_previous
)

Arguments

graf	A mapfile representing a causal map. A mapfile is a tidygraph, which consists of a table of edges linked to a table of nodes, with an optional additional table of statements. In this package, nodes are called 'factors' and edges are called 'links.'
field	A numerical or character field in the factor table.
clear	Logical. Whether to clear any existing labels or to concatenate the new result after any existing labels. Default is 'FALSE'.

Value

A mapfile with a column 'label'. If 'clear' is FALSE, the new label is concatenated after any existing label. The new label is of the form 'field: value'.

stevepowell99/CausalMapFunctions documentation built on Oct. 12, 2023, 11:13 a.m.