rmacroliteRunId-methods: Fetch or set the simulation ID (RUNID) of one or more...

In julienmoeys/rmacrolite: R interface for the pesticide fate models MACRO In FOCUS and MACRO

Description

Fetch or set the simulation ID (RUNID) of one or more imported MACRO simulation parameter sets

Usage

rmacroliteRunId(x, ...)

## S3 method for class 'macroParFile'
rmacroliteRunId(x, ...)

## S3 method for class 'macroParFileList'
rmacroliteRunId(x, ...)

rmacroliteRunId( x, ... ) <- value

## S3 replacement method for class 'macroParFile'
rmacroliteRunId(x, ...) <- value

## S3 replacement method for class 'macroParFileList'
rmacroliteRunId(x, ...) <- value

Arguments

x	A macroParFile object, containing one simulations whose simulation ID (RUNID) should be fetched or set.
...	Additional parameters passed to specific methods.
value	A single or vector of integer. New value(s) for the RUNID

Value

WRITE DESCRIPTION HERE.

Examples

library( "rmacrolite" ) 

# # Setup MACRO directory (if needed)
# rmacroliteSetModelVar( "C:/swash/macro" )



#   Path to an example par-file
par_file_path <- system.file( "par-files", 
    "chat_winCer_GW-X_900gHa_d182.par", 
    package = "rmacrolite" ) 

#   Import the example par-file
par_file <- rmacroliteImportParFile( 
    file = par_file_path ) 



#   Fetch the current parametrization
rmacroliteRunId( x = par_file ) 
    # [1] 1

#   Modify the parameter
par_file2 <- par_file
rmacroliteRunId( x = par_file2 ) <- 555 

#   Check the result
rid <- rmacroliteRunId( x = par_file2 )
rid 
    # [1] 555 

#   Internal control
if( rid != 555 ){ 
    stop( "Test of rmacroliteRunId() failed" ) } 

#   Clean-up
rm( par_file_path, par_file, par_file2, rid  )

julienmoeys/rmacrolite documentation built on May 22, 2019, 6:31 p.m.