adjust.forcing: Adjust Forcing Parameters

View source: R/Adjustments.R

adjust.forcingR Documentation

Adjust Forcing Parameters

Description

Modifies the various forcing parameters of the rsim scenario object.

Usage

adjust.forcing(
  Rsim.scenario,
  parameter,
  group,
  sim.year = 1,
  sim.month = 0,
  bymonth = F,
  value
)

Arguments

Rsim.scenario

Object generated by rsim.scenario.

parameter

The Rsim.scenario forcing parameter to be modified.

group

The model group that the parameter change will affect.

sim.year

Year of the simulation that should be modified. Can be a range of years.

sim.month

Month of the year that should be modified. If set to 0, all months of the year are modified.

bymonth

Boolean value that denotes whether to use sim.year/sim.month combo or just sim.month as a sequential vector starting at 1.

value

The new value for the parameter.

Value

Returns an Rsim.scenario object with the new parameter.

See Also

Other Rpath functions: MTI(), check.rpath.params(), create.rpath.params(), extract.node(), frate.table(), read.rpath.params(), rpath(), rpath.groups(), rpath.stanzas(), stanzaplot(), webplot(), write.Rpath(), write.Rsim(), write.rpath.params()


NOAA-EDAB/Rpath documentation built on June 5, 2024, 9:03 p.m.