Skip to contents

QWAmetadata holds the hierarchical metadata associated with a QWA dataset, structured by level of organisation:

  • $dataset: dataset-level information (name, description, license).

  • $authors: author information.

  • $funding: funding sources and grant numbers.

  • $related: related objects (publications, datasets, etc.).

  • $resources: included resources (data files)

  • $sites: site-level metadata (location, climate, etc.).

  • $trees: tree-level metadata (species, DBH, age, etc.).

  • $woodpieces: woodpiece-level metadata (disc, core, etc.).

  • $slides: slide-level metadata (preparation, staining, etc.).

  • $images: image-level metadata, including the ROXAS output file paths, EXIF data, and ROXAS settings. This is the only required component and is usually populated automatically by build_QWAimages().

All components except images are optional and can be filled in later to prepare a complete dataset submission to the TRIA database.

as_QWAmetadata() safely constructs a QWAmetadata object from a named list. Component names are matched against the QWAmetadata() constructor parameters; unknown names are dropped with a warning.

Usage

QWAmetadata(
  dataset = NULL,
  authors = NULL,
  funding = NULL,
  related = NULL,
  resources = NULL,
  sites = NULL,
  trees = NULL,
  woodpieces = NULL,
  slides = NULL,
  images = data.frame()
)

as_QWAmetadata(x)

Arguments

dataset

Data frame with dataset-level metadata. Typically provided via metadata Shiny app (launch_metadata_app()).

authors

Data frame with author information. Typically provided via metadata Shiny app.

funding

Data frame with funding information. Typically provided via metadata Shiny app.

Data frame with related publications or datasets. Typically provided via metadata Shiny app.

resources

Data frame listing all raw data files to be submitted as part of the dataset. Typically created by collect_resources().

sites

Data frame with site-level metadata. Typically provided via metadata Shiny app.

trees

Data frame with tree-level metadata. Typically provided via metadata Shiny app.

woodpieces

Data frame with woodpiece-level metadata. Typically provided via metadata Shiny app.

slides

Data frame with slide-level metadata. Typically provided via metadata Shiny app.

images

A QWAimages object or plain data frame with image-level metadata. Required. Typically the output of build_QWAimages().

x

A named list with any subset of the QWAmetadata() components.

Value

An object of class QWAmetadata.