derive_annotations: Derive annotations for processed output data

derive_annotationsR Documentation

Derive annotations for processed output data

Description

A processed or derived file can inherit annotations from the input file(s). Currently, this generously facilitates inheritance of many properties except ones that "obviously" shouldn't be inherited, such as "fileFormat" or "comments". These rules are hard-coded and might need to be expanded as the data model changes.

Usage

derive_annotations(
  sample_io,
  template = NULL,
  schema =
    "https://raw.githubusercontent.com/nf-osi/nf-metadata-dictionary/main/NF.jsonld",
  verbose = TRUE
)

Arguments

sample_io

Mapping of input and output files from a workflow.

template

Which template to use when deriving annotations. This controls which attributes are relevant for transfer/keep. If not given, will use whatever is set for the attribute "template".

schema

Reference to data model source.

verbose

Whether to output detailed messages.

Details

If multiple inputs given, this will inherit annotations from the FIRST input.


nf-osi/nfportalutils documentation built on June 10, 2025, 5:08 a.m.