save_history {spinifex}

Save a tour basis array.

Description

Save a tour path so it can later be displayed in many different ways. A wrapper function can mute the noisy text side effects of tourr::save_history. Changes a few argument defaults differ: doesn't scale data columns to (0, 1), max_bases = 10, appends the start basis if tour_path is grand, it isn't already there, and has correct dim.

Usage

save_history(
  data,
  tour_path = tourr::grand_tour(),
  max_bases = 10,
  start = NULL,
  rescale = FALSE,
  sphere = FALSE,
  step_size = Inf,
  verbose = getOption("verbose"),
  ...
)

Arguments

data

Matrix, or data frame containing complete numeric columns

tour_path

Tour path generator. Defaults to tourr::grand_tour.

max_bases

The maximum number of new bases to generate. Some tour paths (like the guided tour) may generate less than the maximum. Defaults to 10.

start

First basis, is appended as first frame grand tour if possible.

rescale

Whether or not to rescale all variables to range (0,1). Defaults to FALSE.

sphere

Whether or not to sphere (whiten) covariance matrix to the identity matrix. Defaults to FALSE.

step_size

Distance (in radians) between target frames (not interpolated frames). Defaults to Inf, forcing new basis generation at each step.

verbose

Whether or not to suppress the text output side effects from tourr::save_history. Defaults to FALSE.

...

Additional arguments passed to tourr::new_tour.

See Also

tourr::save_history tourr::new_tour tourr::grand_tour

Examples

library(spinifex)
dat <- scale_sd(penguins_na.rm[, 1:4])
## A grand tour path
gt_path <- save_history(data = dat, tour_path = grand_tour(), max_bases = 10)
dim(gt_path)

## A 1d grand tour path
gt1d_path <- save_history(dat, grand_tour(d = 1), 10)
dim(gt1d_path)

## A holes guided tour path
holes_path <- save_history(dat, guided_tour(holes(), max.tries = 10))
dim(holes_path)

## These are basis_arrays to be used in ?spinifex::ggtour()