This class is used to represent conservation planning problems. A
conservation planning problem has spatially explicit planning units.
A prioritization involves making a decision on each planning unit (e.g. is
the planning unit going to be turned into a protected area?). Each
planning unit is associated with a cost that represents the cost incurred
by applying the decision to the planning unit. The problem also has a set
of representation targets for each feature. Further, it also has
constraints used to ensure that the solution meets additional
objectives (e.g. certain areas are locked into the solution). Finally,
a conservation planning problem---unlike an optimization problem---also
requires a method to solve the problem. This class represents a
planning problem, to actually build and then solve a planning problem,
use the problem function. Only experts should use this
class directly.
list object containing data.
Objective-class object used to represent how
the targets relate to the solution.
Decision-class object used to represent the
type of decision made on planning units.
Target-class object used to represent
representation targets for features.
Collection-class object used to represent
additional penalties that the problem is subject to.
Collection-class object used to represent
additional constraints that the problem is subject to.
Portfolio-class object used to represent
the method for generating a portfolio of solutions.
Solver-class object used to solve the problem.
x$print()
x$show()
x$repr()
x$get_data(name)
x$set_data(name, value)
x$number_of_total_units()
x$number_of_planning_units()
x$planning_unit_indices()
x$planning_unit_indices_with_finite_costs()
x$planning_unit_costs()
x$number_of_features()
x$feature_names()
x$feature_abundances_in_planning_units()
x$feature_abundances_in_total_units()
x$feature_targets()
x$number_of_zones()
x$zone_names()
x$add_objective(obj)
x$add_decisions(dec)
x$add_portfolio(pol)
x$add_solver(sol)
x$add_constraint(con)
x$add_targets(targ)
x$get_constraint_parameter(id)
x$set_constraint_parameter(id, value)
x$render_constraint_parameter(id)
x$render_all_constraint_parameters()
x$get_objective_parameter(id)
x$set_objective_parameter(id, value)
x$render_objective_parameter(id)
x$render_all_objective_parameters()
x$get_solver_parameter(id)
x$set_solver_parameter(id, value)
x$render_solver_parameter(id)
x$render_all_solver_parameters()
x$get_portfolio_parameter(id)
x$set_portfolio_parameter(id, value)
x$render_portfolio_parameter(id)
x$render_all_portfolio_parameters()
x$get_penalty_parameter(id)
x$set_penalty_parameter(id, value)
x$render_penalty_parameter(id)
x$render_all_penalty_parameters()
character name for object.
an object.
Objective-class object.
Decision-class object.
Constraint-class object.
Portfolio-class object.
Solver-class object.
Target-class object.
RasterLayer-class,
SpatialPolygonsDataFrame-class, or
SpatialLinesDataFrame-class object showing spatial
representation of the planning units and their cost.
Zones-class or data.frame object
containing feature data.
Id object that refers to a specific parameter.
object that the parameter value should become.
print the object.
show the object.
return character representation of the object.
return an object stored in the data field with
the corresponding name. If the object is not present in the
data field, a waiver object is returned.
store an object stored in the data field with
the corresponding name. If an object with that name already
exists then the object is overwritten.
integer number of planning units.
integer indices of the planning units in
the planning unit data.
list of integer
indices of planning units in each zone that have finite cost data.
integer number of units in the cost
data including units that have N cost data.
matrix cost of allocating each planning
unit to each zone. Each column corresponds to a different zone and
each row corresponds to a different planning unit.
integer number of features.
character names of features in problem.
matrix total
abundance of each feature in planning units available in each zone. Each
column corresponds to a different zone and each row corresponds to a
different feature.
matrix total
abundance of each feature in each zone. Each column corresponds to a
different zone and each row corresponds to a different feature.
tibble with feature targets.
integer number of zones.
character names of zones in problem.
return a new ConservationProblem-class
with the objective added to it.
return a new ConservationProblem-class
object with the decision added to it.
return a new ConservationProblem-class
object with the portfolio method added to it.
return a new ConservationProblem-class object
with the solver added to it.
return a new ConservationProblem-class
object with the constraint added to it.
return a copy with the targets added to the problem.
get the value of a parameter (specified by
argument id) used in one of the constraints in the object.
set the value of a parameter (specified by
argument id) used in one of the constraints in the object to
value.
generate a shiny widget to modify
the value of a parameter (specified by argument id).
generate a shiny div
containing all the parameters' widgets.
get the value of a parameter (specified by
argument id) used in the object's objective.
set the value of a parameter (specified by
argument id) used in the object's objective to value.
generate a shiny widget to modify
the value of a parameter (specified by argument id).
generate a shiny div
containing all the parameters' widgets.
get the value of a parameter (specified by
argument id) used in the object's solver.
set the value of a parameter (specified by
argument id) used in the object's solver to value.
generate a shiny widget to modify
the value of a parameter (specified by argument id).
generate a shiny div
containing all the parameters' widgets.
get the value of a parameter (specified by
argument id) used in the object's portfolio.
set the value of a parameter (specified by
argument id) used in objects' solver to value.
generate a shiny widget to modify
the value of a parameter (specified by argument id).
generate a shiny div
containing all the parameters' widgets.