setvalues: Set values for objects subclassing 'mvdf_obj'

Description Usage Arguments Value

Description

This function returns a new object of the same class as 'object' with updated values. Use it as a convenient, pipe-able way to set values for objects subclassing 'mvdf_obj'.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
set_values(
  object,
  mvdf = NULL,
  metadata = NULL,
  appendix = NULL,
  newclass = NULL,
  ...
)

set_mvdf(mvdf, object, metadata = NULL, appendix = NULL, newclass = NULL, ...)

set_metadata(
  metadata,
  object,
  mvdf = NULL,
  appendix = NULL,
  newclass = NULL,
  ...
)

set_appendix(
  appendix,
  object,
  mvdf = NULL,
  metadata = NULL,
  newclass = NULL,
  ...
)

Arguments

object

The object to update.

mvdf

The minimum viable data frame required by the S4 class. If 'NULL' (the default), uses the mvdf from 'object'.

metadata

The metadata to include in the new object. If 'NULL' (the default), uses the metadata from 'object'.

appendix

The appendix to include in the new object. If 'NULL' (the default), uses the appendix from 'object'.

newclass

The class of the object to return. If 'NULL' (the default), returns an object of class 'class(object)'.

...

Any additional arguments used in the constructor function being called.

Value

An S4 object (of class 'newclass' if specified or 'class(object)' if not) with updated values.


mikemahoney218/mvdf documentation built on May 7, 2021, 11:46 a.m.