Package index • oppr

Summary

Summary of the package

Simulated datasets and data simulation functions

sim_actions sim_projects sim_features sim_tree: Simulated data
sim_multi_actions sim_multi_projects sim_multi_features sim_multi_tree: Simulated multi-objective data
simulate_multi_ppp_data(): Simulate multi-objective data for the 'Project Prioritization Protocol'
simulate_ppp_data(): Simulate data for the 'Project Prioritization Protocol'
simulate_ptm_data(): Simulate data for 'Priority threat management'

Functions for creating new problems and solving them

problem(): Project prioritization problem
multi_problem(): Multi-objective project prioritization problem
solve(<OptimizationProblem>,<Solver>) solve(<ProjectProblem>,<missing>) solve(<MultiObjProjectProblem>,<missing>): Solve

Functions for adding an objective to a problem

objectives: Problem objective
add_max_phylo_div_objective(): Add maximum phylogenetic diversity objective
add_max_richness_objective(): Add maximum richness objective
add_max_targets_met_objective(): Add maximum targets met objective
add_max_wtd_sum_objective(): Add maximum weighted sum objective
add_min_set_objective(): Add minimum set objective

Functions for adding weights to a problem

Functions for adding targets to a problem

Functions for adding constraints to a problem

constraints: Project prioritization problem constraints
add_locked_in_action_constraints(): Add locked in action constraints
add_locked_in_project_constraints(): Add locked in project constraints
add_locked_out_action_constraints(): Add locked out action constraints
add_locked_out_project_constraints(): Add locked out project constraints
add_manual_locked_action_constraints(): Add manually specified locked constraints for actions
add_manual_locked_project_constraints(): Add manually specified locked constraints for projects

Functions for specifying the type of decisions in a problem

Functions for specifying how a problem should be solved

Functions for specifying multi-objective optimization approaches

Functions for evaluating and visualizing solutions to a problem

plot(<ProjectProblem>): Plot a solution to a project prioritization problem
plot_solution_barplot(): Plot a bar plot to visualize a project prioritization
plot_solution_phylogram(): Plot a phylogram to visualize a project prioritization
project_cost_effectiveness(): Project cost effectiveness
rank_importance(): Rank importance
replacement_costs(): Replacement cost
solution_statistics(): Solution statistics

Functions for extracting information from problems

Assorted functions distributed with the package

show(<ProjectModifier>) show(<ProjectProblem>) show(<OptimizationProblem>) show(<MultiObjProjectProblem>) show(<MultiObjApproach>): Show
compile() multi_compile(<MultiObjProjectProblem>) multi_compile(<list>): Compile a problem
branch_matrix(): Branch matrix
run_example(): Run example?

Functions that are no longer distributed with the package

plot_feature_persistence() plot_phylo_persistence() add_locked_in_constraints() add_locked_out_constraints() add_manual_locked_constraints(): Deprecation notice

Internal data structures and functions

new_waiver(): Waiver
is.Waiver(): Is waiver?
new_optimization_problem(): Optimization problem
as.list(<OptimizationProblem>): Convert OptimizationProblem to list
Constraint-class Constraint: Constraint class
Decision-class Decision: Decision class
MultiObjApproach-class MultiObjApproach: Multi-objective approach class
MultiObjProjectProblem-class MultiObjProjectProblem: Multi-objective project problem class
Objective-class Objective: Objective class
OptimizationProblem-class OptimizationProblem: Optimization problem class
ProjectModifier-class ProjectModifier: Conservation problem modifier class
ProjectProblem-class ProjectProblem: Project problem class
Solver-class Solver: Solver class
Target-class Target: Target class
Weight-class Weight: Weight class
nrow() ncol() as.list(<tbl_df>): Manipulate tibbles