Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free

bi_class

Create Classes for Bivariate Maps


Description

Creates mapping classes for a bivariate map. These data will be stored in a new variable named bi_class, which will be added to the given data object.

Usage

bi_class(.data, x, y, style = "quantile", dim = 3, keep_factors = FALSE)

Arguments

.data

A data frame, tibble, or sf object

x

The x variable

y

The y variable

style

A string identifying the style used to calculate breaks. Currently supported styles are "quantile" (default), "equal", "fisher", and "jenks".

dim

The dimensions of the palette, either 2 for a two-by-two palette or 3 for a three-by-three palette.

keep_factors

A logical scalar; if TRUE, the intermediate factor variables created as part of the calculation of bi_class will be retained. If FALSE (default), they will not be returned.

Value

A copy of .data with a new variable bi_class that contains combinations of values that correspond to an observations values for x and y. This is the basis for applying a bivariate color palette.

Examples

# quantile breaks, 2x2
data <- bi_class(stl_race_income, x = pctWhite, y = medInc, style = "quantile", dim = 2)

# summarize quantile breaks, 2x2
table(data$bi_class)

# quantile breaks, 3x3
data <- bi_class(stl_race_income, x = pctWhite, y = medInc, style = "quantile", dim = 3)

# summarize quantile breaks, 3x3
table(data$bi_class)

# equal breaks
data <- bi_class(stl_race_income, x = pctWhite, y = medInc, style = "equal", dim = 3)

# summarize equal breaks, 3x3
table(data$bi_class)

# fisher breaks
data <- bi_class(stl_race_income, x = pctWhite, y = medInc, style = "fisher", dim = 3)

# summarize fisher breaks, 3x3
table(data$bi_class)

# jenks breaks
data <- bi_class(stl_race_income, x = pctWhite, y = medInc, style = "jenks", dim = 3)

# summarize jenks breaks, 3x3
table(data$bi_class)

biscale

Tools and Palettes for Bivariate Thematic Mapping

v0.2.0
GPL-3
Authors
Christopher Prener [aut, cre] (<https://orcid.org/0000-0002-4310-9888>), Timo Grossenbacher [aut], Angelo Zehr [aut], Joshua Stevens [ctb]
Initial release

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.