Skip to contents

ProcessingSettings S3 class constructor, methods and functions

Source: R/class_S3_ProcessingSettings.R
ProcessingSettings.Rd

Creates a ProcessingSettings S3 class object. The ProcessingSettings are used in StreamFind for processing data in a given data class method.

Usage

ProcessingSettings(
  engine = NA_character_,
  call = NA_character_,
  algorithm = NA_character_,
  parameters = NULL,
  version = NA_character_,
  software = NA_character_,
  developer = NA_character_,
  contact = NA_character_,
  link = NA_character_,
  doi = NA_character_
)

Arguments

engine

Character of length one with the name of the engine where the processing settings are to be applied.

call

Character of length one with the name of the method where the processing settings are to be applied.

algorithm

Character of length one with the name of the algorithm to be used.

parameters

List with parameters specific for the method call and algorithm.

version

Character of length one with the version of the processing settings.

software

Character of length one with the name of the software or package.

developer

Character of length one with the name of the developer/s.

contact

Character of length one with the email of the developer.

link

Character of length one with the a web link.

doi

Character of length one with the DOI of algorithm.

Value

A ProcessingSettings S3 class