MetadataActionMapping: Metadata action: mapping

In meowcat/SpectraMapping: Mapping between spectra formats

Metadata action: mapping

Description

Metadata action: mapping

Metadata action: mapping

Details

Maps a field in the input data to a field in the output data. By default, registers the output field as a spectraVariable.

Super class

SpectraMapping::MetadataActionBase -> MetadataActionMapping

Public fields

base_settings

source: field of origin target: target field explicit: If TRUE, a star marker is required to register the output field as a spectraVariable. This is FALSE by default, since the main purpose of this action is mapping input to spectraVariables.

Methods

Public methods

• MetadataActionMapping$process_read()

• MetadataActionMapping$process_write()

• MetadataActionMapping$clone()

Inherited methods

• SpectraMapping::MetadataActionBase$execute_read()
• SpectraMapping::MetadataActionBase$execute_write()
• SpectraMapping::MetadataActionBase$initialize()
• SpectraMapping::MetadataActionBase$log_level()
• SpectraMapping::MetadataActionBase$merge_settings()
• SpectraMapping::MetadataActionBase$set_settings()

---

Method process_read()

read implementation

Usage

MetadataActionMapping$process_read(data, params)

Arguments

data

MsBackendMapping to execute the metadata mapping step on

params

List of parameters for a single action (one params entry fully merged.)

---

Method process_write()

write implementation

Usage

MetadataActionMapping$process_write(data, params)

Arguments

data

MsBackendMapping to execute the metadata mapping step on

params

List of parameters for a single action (one params entry fully merged.)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

MetadataActionMapping$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

mapping <- get_proto_action("mapping", source='FIELD', target='field')
backend <-  get_proto_backend(FIELD=c('1','2','3'))
mapped <- mapping$execute_read(backend)

meowcat/SpectraMapping documentation built on May 14, 2024, 6:30 p.m.