neighbours {antaresProcessing} | R Documentation |
This function return a list of neighbours.
neighbours(areas = NULL, virtualAreas = NULL) addNeighbours(antaresData = NULL) getAllNeighbours(areasString = NULL, virtualAreas = NULL)
areas |
A vector with several areas names. |
virtualAreas |
A vector with several virtual areas names. |
antaresData |
Object of class |
areasString |
A string with several areas names separated by an espace, see the examples. |
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.
## 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)