addExportAndImport: Export and import of areas or districts

In rte-antares-rpackage/antaresProcessing: 'Antares' Results Processing

Export and import of areas or districts

Description

This function computes the export and import of areas or districts and add it to an antaresData object.

Usage

addExportAndImport(x, addCapacities = FALSE, opts = NULL)

Arguments

x	an object of class "antaresDataList" created with the function readAntares. It has to contain some areas and all the links that are connected to these areas. Moreover the function "removeVirtualAreas" must be call before.
addCapacities	If TRUE, export and import capacities are added.
opts	opts

Value

addExportAndImport modifies its input by adding to it columns:

export	export for an area or district
import	import for an area or district
capExport	capacity of export for an area or district, if addCapacities is set to TRUE
capImport	capacity of import for an area or district, if addCapacities is set to TRUE

Examples

## Not run: 
# Data required by the function
showAliases("exportsImports")

mydata <- readAntares(select = "exportsImports")
addExportAndImport(mydata)
names(mydata$areas)


## End(Not run)

rte-antares-rpackage/antaresProcessing documentation built on June 30, 2024, 2:28 a.m.