stw_mutate_meta: Modify metadata-object

Description Usage Arguments Details Value Examples

View source: R/stw_mutate_meta.R

Description

Use this function to modify a metadata object, using syntax along the same lines as dplyr::mutate().

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
stw_mutate_meta(...)

## Default S3 method:
stw_mutate_meta(...)

## S3 method for class 'stw_meta'
stw_mutate_meta(meta, ...)

## S3 method for class 'stw_dataset'
stw_mutate_meta(dataset, ...)

Arguments

...

Name-value pairs, passed on to stw_mutate_meta()

meta

Object with S3 class stw_meta, contains meta-data

dataset

Object with S3 class stw_dataset, a data frame with attached meta-data

Details

You can send a metadata (stw_meta) object or a dataset (stw_dataset) object, and get back an object of the same class. In other words, if you call this function using a stw_dataset object, it will modify the metadata, then return a modified copy of the stw_dataset object.

Value

modified copy of meta or dataset

Examples

1

ijlyttle/steward documentation built on Jan. 5, 2021, 2:25 p.m.