R: neighbours

neighbours {antaresProcessing}

R Documentation

neighbours

Description

This function return a list of neighbours.

Usage

neighbours(areas = NULL, virtualAreas = NULL)

addNeighbours(antaresData = NULL)

getAllNeighbours(areasString = NULL, virtualAreas = NULL)

Arguments

`areas`	A vector with several areas names.
`virtualAreas`	A vector with several virtual areas names.
`antaresData`	Object of class `antaresData` created with function `readAntares`.
`areasString`	A string with several areas names separated by an espace, see the examples.

Value

neighbours return a vector with neighbours areas names. addNeighbours modifies its input by adding a column neighbours. getAllNeighbours return a vector with neighbours areas names.

Examples

## Not run: 

res <- neighbours(areas = c("a", "c"),
virtualAreas = getAreas("psp"))

myData <- readAntares(areas = c("a", "c"), links = getLinks("a"),
showProgress = FALSE)

addNeighbours(myData)

res <- getAllNeighbours(areasString = "a b")

## End(Not run)

[Package antaresProcessing version 0.17.0 Index]