# Ecological Restoration Planning

## Documentation for package ‘restoptr’ version 1.0.5

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

add_available_areas_constraint | Add available areas constraint
add_compactness_constraint | Add constraint to limit compactness
add_components_constraint | Add constraint to limit the number of connected components
add_connected_constraint | Add constraint to ensure that the selected planning units for restoration are connected.
add_locked_out_constraint | Add locked out constraint
add_min_iic_constraint | Add constraint to enforce a minimum integral index of connectivity (IIC) value
add_min_mesh_constraint | Add constraint to enforce a minimum effective mesh size (MESH) value
add_restorable_constraint | Add constraint to specify the available amount of surface for restoration
add_settings | Add settings
area_to_nb_cells | Compute the number of cells corresponding to a given area.
cell_area | Compute the area of a cell
cell_width | Compute the width of a cell
get_aggregation_factor | Retrieve the aggregation factor of a restopt problem.
get_cell_area | Retrieve the aggregated cell area of a restopt problem.
get_constraints | Retrieve the constraints of a restopt problem.
get_existing_habitat | Retrieve the existing (i.e. aggregated) habitat data.
get_habitat_threshold | Retrieve the habitat threshold parameter of a restopt problem.
get_locked_out_areas | Retrieve the locked out areas of a restopt problem.
get_metadata | Restopt solution metadata
get_objective | Retrieve the optimization objective of a restopt problem.
get_original_habitat | Retrieve the original (i.e. not aggregated) habitat data.
get_restorable_habitat | Retrieve the restorable habitat (aggregated) data.
get_settings | Retrieve the settings of a restopt problem.
invert_vector | Invert a vector layer according to the extent of a restopt problem.
is_java_available | Is Java is available?
nb_cell_to_area | Compute the area corresponding to a given number of cells.
preprocess_input | Restopr input preprocessing function.
print.RestoptProblem | Print a restoration optimization problem
restoptr | 'restoptr': Ecological Restoration Planning
restopt_problem | Restoration optimization problem
restopt_solution | Restopt solution
set_max_iic_objective | Set an objective to maximize the integral index of connectivity
set_max_mesh_objective | Set an objective to maximize effective mesh size
set_max_nb_pus_objective | Set an objective to maximize the number of planning units
set_max_restore_objective | Set an objective to maximize the amount restoration area.
set_min_nb_pus_objective | Set an objective to minimize the number of planning units
set_min_restore_objective | Set an objective to minimize the amount restoration area.
set_no_objective | Configure the solver to only satisfy the constraints, without optimization objective
solve.RestoptProblem | Solve a restoration optimization problem