getCosts: Get costs associated to edges of a gGraph object

In thibautjombart/geograph: Walking through the geographic space using graphs

Get costs associated to edges of a gGraph object

Description

The function getCosts returns the costs associated to the edges of a gGraph object using different possible outputs. These outputs are designed to match possible outputs of getEdges function.

Usage

getCosts(x, ...)

## S4 method for signature 'gGraph'
getCosts(x, res.type = c("asIs", "vector"), unique = FALSE, ...)

getNodeCosts(x, ...)

## S4 method for signature 'gGraph'
getNodeCosts(x, attr.name, ...)

Arguments

x	a valid gGraph.
...	other arguments passed to other methods (currently unused).
res.type	a character string indicating which kind of output should be used. See value.
unique	a logical indicating whether the costs should be returned for unique edges (TRUE), or if duplicate edges should be considered as well (TRUE, default).
attr.name	the name of the node attribute used to define node costs.

Details

getNodeCosts returns the costs associated to nodes based on one node attribute.

The notion of 'costs' in the context of gGraph objects is identical to the concept of 'weights' in graph (and thus graphNEL) objects. The larger it is for an edge, the less connectivity there is between the couple of concerned nodes.

Value

The output depends on the value of the argument res.type:

• asIs: output is a named list of weights, each slot containing weights associated to the edges stemming from one given node. This format is that of the weights accessor for graphNEL objects.
  

• vector: a vector of weights; this output matches matrix outputs of getEdges.
  

Functions

• getCosts(gGraph): Method for gGraph object

• getNodeCosts(): Function to get the costs values for nodes

• getNodeCosts(gGraph): Method to get node costs for gGraph object

See Also

Most other accessors are documented in gGraph manpage.

Examples

head(getEdges(worldgraph.10k, res.type = "matNames", unique = TRUE))
head(getCosts(worldgraph.10k, res.type = "vector", unique = TRUE))

thibautjombart/geograph documentation built on Jan. 27, 2024, 10 p.m.