get_graphab_metric: Get metrics computed at the node in the Graphab project

View source: R/get_graphab_metric.R

get_graphab_metricR Documentation

Get metrics computed at the node in the Graphab project

Description

The function gets the metrics computed at the node-level in the Graphab project

Usage

get_graphab_metric(proj_name, proj_path = NULL)

Arguments

proj_name

A character string indicating the Graphab project name. The project name is also the name of the project directory in which the file proj_name.xml is.

proj_path

(optional) A character string indicating the path to the directory that contains the project directory. It should be used when the project directory is not in the current working directory. Default is NULL. When 'proj_path = NULL', the project directory is equal to getwd().

Details

The imported metrics describe the patches and have been computed from the different graphs created in the Graphab project. See more information in Graphab 2.8 manual: https://sourcesup.renater.fr/www/graphab/download/manual-2.8-en.pdf

Value

A data.frame with metrics computed at the patch level.

Author(s)

P. Savary

Examples

## Not run: 
get_graphab_metric(proj_name = "grphb_ex")

## End(Not run)

graph4lg documentation built on Feb. 16, 2023, 5:43 p.m.