scatteR: Generate scatterplots based on the scagnostics measurement

View source: R/scatteR.R

scatteRR Documentation

Generate scatterplots based on the scagnostics measurement

Description

Generate scatterplots based on the scagnostics measurement

Usage

scatteR(
  measurements = c(Monotonic = 1, Outlying = 0.5),
  n_points = 50,
  init_points = NULL,
  global_min = 0.001,
  error_var = 0.001,
  epochs = 100,
  seed = 1835,
  verbose = TRUE,
  loss = "mae",
  ...
)

Arguments

measurements

A named vector containing the scagnostic measurements that the resulting scatterplot should have

n_points

The number of points that the resulting scatterplot should have.

init_points

The number of initial points to use to build the iterative scatterplots. Default is NULL in which case the factors of n_points will be calculated and the 25th quantile from the set of factors will be used.

global_min

the error that the resulting scagnostics can give

error_var

the variance of the random error that is added on to the existing points

epochs

number of epochs the optimization method should run

seed

The random number generation seed

verbose

Logical. TRUE means that messages from the optimization algorithm are shown. Default is TRUE

loss

The loss function to be used within the scatteR program. Can be either 'mae' or 'mse'. Default is 'mae'

...

Extra arguments to be used in the control argument of the GenSA function of the GenSA package

Value

A bivariate data.frame with two columns named x and y that gives a roughly similar scagnostic measurement to the 'measurements' argument


scatteR documentation built on Aug. 17, 2022, 9:05 a.m.