valid_resource_capacity: Return valid resource capacity array

View source: R/setMultipleResources.R

valid_resource_capacityR Documentation

Return valid resource capacity array

Description

If ⁠resource capacity⁠ is given it is checked for validity. If it does not have a comment, then it is given the comment "set manually". This is then returned. If ⁠resource capacity⁠ is missing or NULL, but one was set by the user and stored in params with a comment, then this is returned. Otherwise a resource capacity is calculated from resource_params. If this is NULL to it is taken from params.

Usage

valid_resource_capacity(
  params,
  resource_params = NULL,
  resource_capacity = NULL
)

Arguments

params

A MizerParams object

resource_capacity

Array (resource x size) of the intrinsic resource carrying capacities

Value

An array (resource x size) with the resource capacities


sizespectrum/mizerMR documentation built on July 21, 2023, 1:01 p.m.