get_metadata: Restopt solution metadata

In restoptr: Ecological Restoration Planning

Restopt solution metadata

Description

Return the metadata associated with a restopt solution, which contains the characteristics of the solution. The unit for area characteristics can be chosen among "ha" (hectares), "m" (square meters), "km" (square kilometers), and "cells" (cells from the original input habitat raster). Note that the solving time is expressed in seconds.

Usage

get_metadata(restopt_solution, area_unit = "ha", distance_unit = "m")

Arguments

restopt_solution	restopt_solution() Restopt solution to this solution.
area_unit	unit object or a character that can be coerced to an area unit (see unit package), or "cells" for number of cells from the original habitat raster). Unit for areas. If the input habitat raster does not use a projected coordinate system, only "cells" is available. Default is "ha"
distance_unit	unit object or a character that can be coerced to an area unit (see unit package), or "cells" for number of cell width from the original habitat raster). Unit for distances. If the input habitat raster does not use a projected coordinate system, only "cells" is available. Default is "m"

Value

A list containing the characteristics of the restopt solution.

restoptr documentation built on Aug. 12, 2025, 1:08 a.m.