x3p_surface_rescale: Get Surface Summary Statistics from x3p object Rescale...

View source: R/x3p_surf_stat_rescale.R

x3p_surface_rescaleR Documentation

Get Surface Summary Statistics from x3p object Rescale Surface of an x3p object

Description

This function takes a single or multiple x3p objects and allows a user to obtain summary statistics regarding the surface.

Usage

x3p_surface_rescale(
  df,
  obtain = c("minimum", "maximum", "both", "rescale"),
  multiple = FALSE,
  select_col,
  value
)

Arguments

df

object of class 'x3p' or a tibble style dataframe containing 'x3p' objects

obtain

user specification for which statistic/action they wish to obtain/perform

multiple

clarify whether user is working with a single 'x3p' object or multiple in a tibble style dataframe

select_col

if multiple = TRUE, location of the x3p objects

value

user specified value for rescaling surface elements of an 'x3p' object

Details

This function also takes single or multiple x3p objects and allows the user to rescale the surface elements.

Value

Statistics regarding surface of 'x3p' object

Rescaled surface.matrix of 'x3p' object


xazip/x3pLeaX documentation built on July 14, 2022, 5:37 p.m.