workflowStepSet-class: (Virtual) base class for sets related workflow objects

In rickhelmus/patRoon: Workflows for Mass-Spectrometry Based Non-Target Analysis

(Virtual) base class for sets related workflow objects

Description

This class is the base for many sets workflows related classes. This class is virtual, and therefore never created directly.

Usage

## S4 method for signature 'workflowStepSet'
setObjects(obj)

## S4 method for signature 'workflowStepSet'
sets(obj)

## S4 method for signature 'workflowStepSet'
show(object)

Arguments

obj, object

An object that is derived from workflowStepSet.

Details

The most important purpose of this class is to hold data that is specific for a set. These set objects are typically objects with classes from a regular non-sets workflow (e.g. components, compounds), and are used by the sets workflow object to e.g. form a consensus. Since the set objects may contain additional data, such as algorithm specific slots, it may in some cases be of interest to access them directly with the setObjects method (described below).

Methods (by generic)

• setObjects(workflowStepSet): Accessor for the setObjects slot.

• sets(workflowStepSet): Returns the names for each set in this object.

• show(workflowStepSet): Shows summary information for this object.

Slots

setObjects

A list with the set objects (see the ⁠Details⁠ section). The list is named with the set names.

S4 class hierarchy

• workflowStepSet

  • componentsSet

    • componentsNTSet

  • featureGroupsScreeningSet

  • compoundsSet

    • compoundsConsensusSet

  • formulasSet

    • formulasConsensusSet

  • MSPeakListsSet

rickhelmus/patRoon documentation built on Nov. 22, 2024, 3:11 p.m.