swInputData-class: Class '"swInputData"'

In Burke-Lauenroth-Lab/Rsoilwat: An Ecohydrological Ecosystem-Scale Water Balance Simulation Model

Class "swInputData"

Description

This class is a container class to the input file S4 objects. The generic functions listed work on this and the proper rSOILWAT2 classes in the container's slots.

Usage

swInputData(...)

## S4 method for signature 'swInputData'
get_swFiles(object)

## S4 method for signature 'swInputData'
swFiles_ProjDir(object)

## S4 method for signature 'swInputData'
swFiles_filesIn(object)

## S4 method for signature 'swInputData'
swFiles_Years(object)

## S4 method for signature 'swInputData'
swFiles_LogFile(object)

## S4 method for signature 'swInputData'
swFiles_SiteParams(object)

## S4 method for signature 'swInputData'
swFiles_Soils(object)

## S4 method for signature 'swInputData'
swFiles_SWRCp(object)

## S4 method for signature 'swInputData'
swFiles_WeatherSetup(object)

## S4 method for signature 'swInputData'
swFiles_MarkovProbs(object)

## S4 method for signature 'swInputData'
swFiles_MarkovCov(object)

## S4 method for signature 'swInputData'
swFiles_Cloud(object)

## S4 method for signature 'swInputData'
swFiles_Prod(object)

## S4 method for signature 'swInputData'
swFiles_Estab(object)

## S4 method for signature 'swInputData'
swFiles_Carbon(object)

## S4 method for signature 'swInputData'
swFiles_SWCsetup(object)

## S4 method for signature 'swInputData'
swFiles_Output(object)

## S4 method for signature 'swInputData'
swFiles_WeatherPrefix(object)

## S4 method for signature 'swInputData'
swFiles_OutputPrefix(object)

## S4 replacement method for signature 'swInputData'
set_swFiles(object) <- value

## S4 replacement method for signature 'swInputData'
swFiles_ProjDir(object) <- value

## S4 replacement method for signature 'swInputData'
swFiles_filesIn(object) <- value

## S4 replacement method for signature 'swInputData'
swFiles_Years(object) <- value

## S4 replacement method for signature 'swInputData'
swFiles_LogFile(object) <- value

## S4 replacement method for signature 'swInputData'
swFiles_SiteParams(object) <- value

## S4 replacement method for signature 'swInputData'
swFiles_Soils(object) <- value

## S4 replacement method for signature 'swInputData'
swFiles_SWRCp(object) <- value

## S4 replacement method for signature 'swInputData'
swFiles_WeatherSetup(object) <- value

## S4 replacement method for signature 'swInputData'
swFiles_MarkovProbs(object) <- value

## S4 replacement method for signature 'swInputData'
swFiles_MarkovCov(object) <- value

## S4 replacement method for signature 'swInputData'
swFiles_Cloud(object) <- value

## S4 replacement method for signature 'swInputData'
swFiles_Prod(object) <- value

## S4 replacement method for signature 'swInputData'
swFiles_Estab(object) <- value

## S4 replacement method for signature 'swInputData'
swFiles_Carbon(object) <- value

## S4 replacement method for signature 'swInputData'
swFiles_SWCsetup(object) <- value

## S4 replacement method for signature 'swInputData'
swFiles_Output(object) <- value

## S4 replacement method for signature 'swInputData'
swFiles_WeatherPrefix(object) <- value

## S4 replacement method for signature 'swInputData'
swFiles_OutputPrefix(object) <- value

## S4 method for signature 'swInputData'
get_swYears(object)

## S4 method for signature 'swInputData'
swYears_StartYear(object)

## S4 method for signature 'swInputData'
swYears_EndYear(object)

## S4 method for signature 'swInputData'
swYears_FDOFY(object)

## S4 method for signature 'swInputData'
swYears_EDOEY(object)

## S4 method for signature 'swInputData'
swYears_isNorth(object)

## S4 replacement method for signature 'swInputData'
set_swYears(object) <- value

## S4 replacement method for signature 'swInputData'
swYears_StartYear(object) <- value

## S4 replacement method for signature 'swInputData'
swYears_EndYear(object) <- value

## S4 replacement method for signature 'swInputData'
swYears_FDOFY(object) <- value

## S4 replacement method for signature 'swInputData'
swYears_EDOEY(object) <- value

## S4 replacement method for signature 'swInputData'
swYears_isNorth(object) <- value

## S4 method for signature 'swInputData'
get_swCloud(object)

## S4 replacement method for signature 'swInputData'
set_swCloud(object) <- value

## S4 method for signature 'swInputData'
get_swWeather(object)

## S4 method for signature 'swInputData'
swWeather_DaysRunningAverage(object)

## S4 method for signature 'swInputData'
swWeather_FirstYearHistorical(object)

## S4 method for signature 'swInputData'
swWeather_pct_SnowDrift(object)

## S4 method for signature 'swInputData'
swWeather_pct_SnowRunoff(object)

## S4 method for signature 'swInputData'
swWeather_UseMarkov(object)

## S4 method for signature 'swInputData'
swWeather_UseMarkovOnly(object)

## S4 method for signature 'swInputData'
swWeather_UseSnow(object)

## S4 method for signature 'swInputData'
swWeather_MonScalingParams(object)

## S4 replacement method for signature 'swInputData'
set_swWeather(object) <- value

## S4 replacement method for signature 'swInputData'
swWeather_DaysRunningAverage(object) <- value

## S4 replacement method for signature 'swInputData'
swWeather_FirstYearHistorical(object) <- value

## S4 replacement method for signature 'swInputData'
swWeather_pct_SnowDrift(object) <- value

## S4 replacement method for signature 'swInputData'
swWeather_pct_SnowRunoff(object) <- value

## S4 replacement method for signature 'swInputData'
swWeather_UseMarkov(object) <- value

## S4 replacement method for signature 'swInputData'
swWeather_UseMarkovOnly(object) <- value

## S4 replacement method for signature 'swInputData'
swWeather_UseSnow(object) <- value

## S4 replacement method for signature 'swInputData'
swWeather_MonScalingParams(object) <- value

## S4 method for signature 'swInputData'
get_swCloud(object)

## S4 method for signature 'swInputData'
swCloud_SkyCover(object)

## S4 method for signature 'swInputData'
swCloud_WindSpeed(object)

## S4 method for signature 'swInputData'
swCloud_Humidity(object)

## S4 method for signature 'swInputData'
swCloud_SnowDensity(object)

## S4 method for signature 'swInputData'
swCloud_RainEvents(object)

## S4 replacement method for signature 'swInputData'
set_swCloud(object) <- value

## S4 replacement method for signature 'swInputData'
swCloud_SkyCover(object) <- value

## S4 replacement method for signature 'swInputData'
swCloud_WindSpeed(object) <- value

## S4 replacement method for signature 'swInputData'
swCloud_Humidity(object) <- value

## S4 replacement method for signature 'swInputData'
swCloud_SnowDensity(object) <- value

## S4 replacement method for signature 'swInputData'
swCloud_RainEvents(object) <- value

## S4 method for signature 'swInputData'
get_Markov(object)

## S4 method for signature 'swInputData'
get_swMarkov(object)

## S4 method for signature 'swInputData'
swMarkov_Prob(object)

## S4 method for signature 'swInputData'
swMarkov_Conv(object)

## S4 replacement method for signature 'swInputData'
set_Markov(object) <- value

## S4 replacement method for signature 'swInputData'
set_swMarkov(object) <- value

## S4 replacement method for signature 'swInputData'
swMarkov_Prob(object) <- value

## S4 replacement method for signature 'swInputData'
swMarkov_Conv(object) <- value

## S4 method for signature 'swInputData'
get_WeatherHistory(object)

## S4 replacement method for signature 'swInputData,list'
set_WeatherHistory(object) <- value

## S4 method for signature 'swInputData'
get_swWeatherData(object, year)

## S4 method for signature 'list'
get_swWeatherData(object, year)

## S4 replacement method for signature 'swInputData,swWeatherData'
set_swWeatherData(object) <- value

## S4 replacement method for signature 'list,swWeatherData'
set_swWeatherData(object) <- value

## S4 method for signature 'swInputData'
get_swProd(object)

## S4 method for signature 'swInputData'
swProd_Composition(object)

## S4 method for signature 'swInputData'
swProd_Albedo(object)

## S4 method for signature 'swInputData'
swProd_CanopyHeight(object)

## S4 method for signature 'swInputData'
swProd_VegInterParam(object)

## S4 method for signature 'swInputData'
swProd_LitterInterParam(object)

## S4 method for signature 'swInputData'
swProd_EsTpartitioning_param(object)

## S4 method for signature 'swInputData'
swProd_Es_param_limit(object)

## S4 method for signature 'swInputData'
swProd_Shade(object)

## S4 method for signature 'swInputData'
swProd_HydrRedstro_use(object)

## S4 method for signature 'swInputData'
swProd_HydrRedstro(object)

## S4 method for signature 'swInputData'
swProd_CritSoilWaterPotential(object)

## S4 method for signature 'swInputData'
swProd_CO2Coefficients(object)

## S4 method for signature 'swInputData,ANY'
swProd_MonProd_veg(object, vegtype)

## S4 method for signature 'swInputData'
swProd_MonProd_grass(object)

## S4 method for signature 'swInputData'
swProd_MonProd_shrub(object)

## S4 method for signature 'swInputData'
swProd_MonProd_tree(object)

## S4 method for signature 'swInputData'
swProd_MonProd_forb(object)

## S4 replacement method for signature 'swInputData'
set_swProd(object) <- value

## S4 replacement method for signature 'swInputData'
swProd_Composition(object) <- value

## S4 replacement method for signature 'swInputData'
swProd_Albedo(object) <- value

## S4 replacement method for signature 'swInputData'
swProd_CanopyHeight(object) <- value

## S4 replacement method for signature 'swInputData'
swProd_VegInterParam(object) <- value

## S4 replacement method for signature 'swInputData'
swProd_LitterInterParam(object) <- value

## S4 replacement method for signature 'swInputData'
swProd_EsTpartitioning_param(object) <- value

## S4 replacement method for signature 'swInputData'
swProd_Es_param_limit(object) <- value

## S4 replacement method for signature 'swInputData'
swProd_Shade(object) <- value

## S4 replacement method for signature 'swInputData'
swProd_HydrRedstro_use(object) <- value

## S4 replacement method for signature 'swInputData'
swProd_HydrRedstro(object) <- value

## S4 replacement method for signature 'swInputData'
swProd_CritSoilWaterPotential(object) <- value

## S4 replacement method for signature 'swInputData'
swProd_CO2Coefficients(object) <- value

## S4 replacement method for signature 'swInputData,ANY,ANY'
swProd_MonProd_veg(object, vegtype) <- value

## S4 replacement method for signature 'swInputData'
swProd_MonProd_grass(object) <- value

## S4 replacement method for signature 'swInputData'
swProd_MonProd_shrub(object) <- value

## S4 replacement method for signature 'swInputData'
swProd_MonProd_tree(object) <- value

## S4 replacement method for signature 'swInputData'
swProd_MonProd_forb(object) <- value

## S4 method for signature 'swInputData'
get_swEstab(object)

## S4 method for signature 'swInputData'
get_swSite(object)

## S4 method for signature 'swInputData'
swSite_SWClimits(object)

## S4 method for signature 'swInputData'
swSite_ModelFlags(object)

## S4 method for signature 'swInputData'
swSite_ModelCoefficients(object)

## S4 method for signature 'swInputData'
swSite_SnowSimulationParams(object)

## S4 method for signature 'swInputData'
swSite_DrainageCoefficient(object)

## S4 method for signature 'swInputData'
swSite_EvapCoefficients(object)

## S4 method for signature 'swInputData'
swSite_TranspCoefficients(object)

## S4 method for signature 'swInputData'
swSite_IntrinsicSiteParams(object)

## S4 method for signature 'swInputData'
swSite_SoilTemperatureFlag(object)

## S4 method for signature 'swInputData'
swSite_SoilTemperatureConsts(object)

## S4 method for signature 'swInputData'
swSite_SoilDensityInputType(object)

## S4 method for signature 'swInputData'
swSite_TranspirationRegions(object)

## S4 replacement method for signature 'swInputData'
set_swSite(object) <- value

## S4 replacement method for signature 'swInputData'
swSite_SWClimits(object) <- value

## S4 replacement method for signature 'swInputData'
swSite_ModelFlags(object) <- value

## S4 replacement method for signature 'swInputData'
swSite_ModelCoefficients(object) <- value

## S4 replacement method for signature 'swInputData'
swSite_SnowSimulationParams(object) <- value

## S4 replacement method for signature 'swInputData'
swSite_DrainageCoefficient(object) <- value

## S4 replacement method for signature 'swInputData'
swSite_EvapCoefficients(object) <- value

## S4 replacement method for signature 'swInputData'
swSite_TranspCoefficients(object) <- value

## S4 replacement method for signature 'swInputData'
swSite_IntrinsicSiteParams(object) <- value

## S4 replacement method for signature 'swInputData'
swSite_SoilTemperatureFlag(object) <- value

## S4 replacement method for signature 'swInputData'
swSite_SoilTemperatureConsts(object) <- value

## S4 replacement method for signature 'swInputData'
swSite_SoilDensityInputType(object) <- value

## S4 replacement method for signature 'swInputData'
swSite_TranspirationRegions(object) <- value

## S4 method for signature 'swInputData'
get_swSoils(object)

## S4 replacement method for signature 'swInputData,swSoils'
set_swSoils(object) <- value

## S4 replacement method for signature 'swInputData,list'
set_swSoils(object) <- value

## S4 method for signature 'swInputData'
get_swSWC(object)

## S4 method for signature 'swInputData'
swSWC_use(object)

## S4 method for signature 'swInputData'
swSWC_prefix(object)

## S4 method for signature 'swInputData'
swSWC_FirstYear(object)

## S4 method for signature 'swInputData'
swSWC_Method(object)

## S4 method for signature 'swInputData'
swSWC_HistoricList(object)

## S4 method for signature 'swInputData'
swSWC_HistoricData(object, year)

## S4 replacement method for signature 'swInputData,swSWC'
set_swSWC(object) <- value

## S4 replacement method for signature 'swInputData,logical'
swSWC_use(object) <- value

## S4 replacement method for signature 'swInputData,character'
swSWC_prefix(object) <- value

## S4 replacement method for signature 'swInputData,integer'
swSWC_FirstYear(object) <- value

## S4 replacement method for signature 'swInputData,integer'
swSWC_Method(object) <- value

## S4 replacement method for signature 'swInputData,list'
swSWC_HistoricList(object) <- value

## S4 replacement method for signature 'swInputData,swSWC_hist'
swSWC_HistoricData(object) <- value

## S4 method for signature 'swInputData'
get_swCarbon(object)

## S4 method for signature 'swInputData'
swCarbon_Use_Bio(object)

## S4 method for signature 'swInputData'
swCarbon_Use_WUE(object)

## S4 method for signature 'swInputData'
swCarbon_Scenario(object)

## S4 method for signature 'swInputData'
swCarbon_DeltaYear(object)

## S4 method for signature 'swInputData'
swCarbon_CO2ppm(object)

## S4 replacement method for signature 'swInputData'
set_swCarbon(object) <- value

## S4 replacement method for signature 'swInputData'
swCarbon_Use_Bio(object) <- value

## S4 replacement method for signature 'swInputData'
swCarbon_Use_WUE(object) <- value

## S4 replacement method for signature 'swInputData'
swCarbon_Scenario(object) <- value

## S4 replacement method for signature 'swInputData'
swCarbon_DeltaYear(object) <- value

## S4 replacement method for signature 'swInputData'
swCarbon_CO2ppm(object) <- value

## S4 method for signature 'swInputData'
get_swOUT(object)

## S4 method for signature 'swInputData'
swOUT_TimeStep(object)

## S4 method for signature 'swInputData'
swOUT_OutputSeparator(object)

## S4 replacement method for signature 'swInputData'
set_swOUT(object) <- value

## S4 replacement method for signature 'swInputData'
swOUT_TimeStep(object) <- value

## S4 replacement method for signature 'swInputData'
swOUT_TimeStepsForEveryKey(object) <- value

## S4 replacement method for signature 'swInputData'
swOUT_OutputSeparator(object) <- value

## S4 replacement method for signature 'swInputData'
activate_swOUT_OutKey(object) <- value

## S4 replacement method for signature 'swInputData'
deactivate_swOUT_OutKey(object) <- value

## S4 replacement method for signature 'swInputData'
swLog_setLine(object) <- value

## S4 method for signature 'swInputData,character'
swReadLines(object, file)

Arguments

...	Arguments to the helper constructor function. Dots can either contain objects to copy into slots of that class (must be named identical to the corresponding slot) or be one object of that class (in which case it will be copied and any missing slots will take their default values). If dots are missing, then corresponding values of rSOILWAT2::sw_exampleData (i.e., the SOILWAT2 "testing" defaults) are copied.
object	An object of class swInputData.
value	A value to assign to a specific slot of the object.
year	An integer value. The calendar year of the weather or SWC data object.
vegtype	The name or index of the vegetation type.
file	A character string. The file name from which to read.

Details

swInputData consists of slots for each file that is read in. These slots can be accessed via the following functions:

• get_swMarkov

• get_swCloud

• get_swFiles

• get_swOUT

• get_swProd

• get_swSite

• get_swSoils

• get_swSWC

• get_swWeather

• get_swWeatherData

• get_swYears

• get_WeatherHistory

Generic methods to get/set individual elements follow a format: "sw" + filename + "_" + option, e.g.

• swFiles_Cloud

• swProd_Albedo

See Also

swFiles swYears swWeather swCloud swMarkov swProd swSite swSoils swEstab swOUT swSWC swLog swCarbon

Examples

showClass("swInputData")
x <- new("swInputData") # prototype
x <- swInputData() # constructor helper

Burke-Lauenroth-Lab/Rsoilwat documentation built on Dec. 9, 2023, 12:41 a.m.