get_graphab_raster_codes: Get unique raster codes from a Graphab project

Description Usage Arguments Value Author(s) Examples

View source: R/get_graphab_raster_codes.R

Description

The function extracts unique raster codes from a Graphab project

Usage

1
get_graphab_raster_codes(proj_name, mode = "all", 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 will be created.

mode

A character string equal to either 'all' (default) or 'habitat' indicating whether the returned codes are all the codes of the source raster used for creating the project or only the code corresponding to the habitat patches.

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().

Value

The function returns a vector of integer values corresponding to the source raster codes (all the codes or only the one corresponding to habitat patches).

Author(s)

P. Savary

Examples

1
2
3
4
5
6
## Not run: 
proj_name <- "grphb_ex"
get_graphab_raster_codes(proj_name = proj_name,
               mode = "all")

## End(Not run)

graph4lg documentation built on March 16, 2021, 5:09 p.m.