processing_step: Stores specifications of a 'collection' processing step

Description Usage Arguments Details Value Examples

View source: R/processing_step.R

Description

Processing steps specification are stored in a step object. This will be typically handled internally.

Usage

1
2
3
4
5
6
7
processing_step(...)

## Default S3 method:
processing_step(fun, arglist, name = "none", id = "none", ...)

## S3 method for class 'processing_step'
tidy(x, ...)

Arguments

...

further arguments passed to or from other methods(not currenctly used).

fun

either a function or a non-empty character string naming the function to be called.

arglist

a list of arguments to the function call. The names attribute of args gives the argument names.

name

A string description of the step

id

An id associated with the step. Will be converted to a unique id.

x

A processing_stepobject

Details

A processing_step stores the function call and associated arguments to reproduce a processing step at a later time point a a different collection object.

Value

An object of class processing_step

A tibble representation of x

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
library(tidySpectR)

# Creating a masking step
stp <- 
   processing_step(
     fun = mask, 
     arglist = list(from = 5, to = Inf),
     type = "masking", 
     name = "masking")

stp
library(tidySpectR)

# Creating a masking step
stp <- 
   processing_step(
     fun = mask, 
     arglist = list(from = 5, to = Inf),
     type = "masking", 
     name = "masking")

tidy(stp)

CVUA-RRW/tidySpectR documentation built on April 13, 2021, 11:41 a.m.