Skip to contents

Main package documentation.

IAM
Impact Assesment Model

Importing data

Function used to import dataset from .xlsx format. It will create an iamInput class object.

IAM.input()
'iamInput' objects creator

Setting model parameters

Open a GUI to set model parameters. It will create an iamArgs class object from a iamInput class object.

IAM.args()
'iamArgs' objects creator by GUI
IAM.input2args()
'iamArgs' objects creator by code

Editing model parameters

Function for parameters modifications. It will create an iamArgs class object from a iamArgs class object.

IAM.args_scenar()
Get Scenario arguments
IAM.editArgs_Eco()
Modify Economic arguments
IAM.editArgs_Gest()
Modify Gestion arguments
IAM.editArgs_Rep()
Modify Replicates arguments
IAM.editArgs_Scenar()
Modify Scenario arguments

Running a simulation.

Takes iamInput and iamArgs class objects to run a simulation. It will create a iamOutput class object.

IAM.model()
Running an IAM simulation.

Extract information from ‘iamOutput’

Function for parameters modifications. It will create an iamArgs class object from a iamArgs class object.

IAM.format() format_vareco() format_varsp()
Format IAM.output variable as a tibble.
IAM.format_quant()
Simplify multiple simulations

Classes

IAM use multiple S4 classes. Basic summary methods are also present. iamOutputRep class is softly deprecrated.

iamArgs-class
Class "iamArgs"
iamInput-class
Class "iamInput"
iamOutput-class
Class "iamOutput"
iamOutputRep-class
Class "iamOutputRep"
summary(<iamArgs>)
summary method for iamInput class
summary(<iamInput>)
summary method for iamInput class

Example dataset

Dataset used in vignette.

IAM_input_2009 IAM_argum_2009
Complete IAM dataset
IAM_example()
Path to the IAM extdata files

Misc

IAM.dev()
Initiate a project with files and directory
IAM_theme()
Theme for IAM plots
dimcst() `set_dimcst<-`()
DimCst

Deprecated Functions

IAM.export()
Exporting IAM objects as readable .txt file
IAM.unite()
Formating method for grouping various iamOutput-class or iamOutputRep-class objects