Stores specifications of a collection processing step

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

processing_step(...)

# S3 method for default
processing_step(fun, arglist, name = "none", id = "none", ...)

# S3 method for 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

Value

An object of class processing_step

A tibble representation of x

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.

Examples

library(tidySpectR)

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

stp
#> $id
#> [1] "none_400719"
#> 
#> $name
#> [1] "masking"
#> 
#> $fun
#> [1] "mask"
#> 
#> $arglist
#> $arglist$from
#> [1] 5
#> 
#> $arglist$to
#> [1] Inf
#> 
#> 
#> attr(,"class")
#> [1] "processing_step"
library(tidySpectR)

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

tidy(stp)
#> # A tibble: 1 x 5
#>   name    method  from    to id         
#>   <chr>   <chr>  <dbl> <dbl> <chr>      
#> 1 masking mask       5   Inf none_213172