Changelog

Source: NEWS.md

oppr 1.1.0

• New multi_problem() function to build multi-objective project prioritization problems.
• New add_max_wtd_sum_objective() function that is designed for datasets when some (or all) of the features do not have probability values to describe their expected outcome when projects are completed. For example, this may be useful when the expected outcome values for a feature reflect the total amount of land expected to be covered by an ecosystem, or the number of individuals present in a population.
• New add_cbc_solver() and add_highs_solver() to generate solutions with the CBC and HiGHS optimization software.
• New add_ref_point_approach(), add_wtd_goal_approach(), and add_abs_constraint_approach() functions for multi-objective optimization.
• New add_locked_in_project_constraints(), add_locked_out_project_constraints(), and add_manual_locked_project_constraints() functions for adding constraints to lock the selection of projects during optimization.
• Update problem() to be compatible with outcome data that are not probabilities of persistence (e.g., amount of land covered by an ecosystem).
• Update plot() functions to be compatible with updates to ggplot2 package.
• Update Matrix package version dependency (#20).
• Update class system to use R6 classes instead of proto classes.
• Update unit tests for compatibility with testthat edition 3.
• Rename plot_phylo_persistence() to plot_solution_phylogram().
• Rename plot_feature_persistence() to plot_solution_barplot().
• Rename add_max_richness_objective() to add_max_wtd_sum_objective().
• Rename add_locked_in_constraints() to add_locked_in_action_constraints().
• Rename add_locked_out_constraints() to add_locked_out_action_constraints().
• Rename add_manual_locked_constraints() to add_manual_locked_action_constraints().
• Remove unused functionality for shiny application integration.
• Remove S3 methods for interacting with new_optimization_problem() objects.

oppr 1.0.5

CRAN release: 2025-06-27

• CRAN release.
• Fix issue with vignette failing to build when the fansi package is not installed.
• Add fansi package to optional dependencies (#22).
• Fix bug in add_lpsolveapi_solver().

oppr 1.0.4.1

• Fix aliasing for package manual entry (#21).
• Fix compatibility with updates to ggplot2 package.
• Fix compatibility with updates to package citation format.
• Fix broken URLs in package documentation.
• Fix broken badges in README.

oppr 1.0.4

CRAN release: 2022-09-08

• CRAN release.
• Fix compiler warnings raised by CRAN checks.
• Remove references to the ggtree package in documentation.
• Fix memory issues encountered during installation on CRAN Windows server.
• Fix compatibility issues with upcoming version of the Matrix package (version 1.4-2).
• Fix broken URLs in package documentation.

oppr 1.0.3

CRAN release: 2021-05-11

• CRAN release.
• Fix URLs for CRAN.

oppr 1.0.2.5

• Update minimum versions for tidytree and ggtree package dependencies. This is because some older versions of tidytree are not compatible with some older versions of the ggtree package.

oppr 1.0.2.4

• Fix missing dependency in DESCRIPTION.

oppr 1.0.2.3

• Bug fix: previous versions of the package reported that the gap parameter for the add_rsymphony_solver and add_lpsymphony_solver corresponded to the maximum absolute difference from the optimal objective value. This was an error due to misunderstanding the SYMPHONY documentation. Under previous versions of the package, the gap parameter actually corresponded to a relative optimality gap expressed as a percentage (such thatgap = 10 indicates that solutions must be at least 10% from optimality). We have now fixed this error and the documentation described for the gap parameter is correct. We apologize for any inconvenience this may have caused.
• Update add_rsymphony_solver and add_lpsymphony_solver functions to have a default time_limit argument set as the maximum machine integer for consistency.
• Update add_rsymphony_solver, add_lpsymphony_solver, and add_gurobi_solver functions to require logical (TRUE/FALSE) arguments for the first_feasible parameter.
• Standardize run time calculations across all solvers.
• Fix compatibility issues between the testthat R package and the gurobi R package in package tests.

oppr 1.0.2.2

• Implement GitHub Actions continuous integration (i.e. update tests and README).
• Update examples to use \dontrun instead of \donttest per CRAN policies.

oppr 1.0.2.1

• Fix “Non-file package-anchored link(s) in documentation object” warnings in R-devel checks.

oppr 1.0.2

CRAN release: 2020-05-20

• CRAN release.

oppr 1.0.1.1

• Replace tibble::as.tibble with tibble::as_tibble to avoid warnings.

oppr 1.0.1

CRAN release: 2020-03-11

• CRAN release.

oppr 1.0.0.1

• Fix compatibility issues with upcoming tibble (3.0.0) R package.

oppr 1.0.0

CRAN release: 2020-02-07

• CRAN release.

oppr 0.0.4.1

• Fix warnings in R-devel CRAN checks related to documentation.
• Add citation for the research article that accompanies this package.

oppr 0.0.4

CRAN release: 2019-08-10

• CRAN release.

oppr 0.0.3.1

• Fix typo.
• Fix broken links to Gurobi academic licenses.

oppr 0.0.3

CRAN release: 2019-04-10

• CRAN release.

oppr 0.0.2.1

• Retain debugging symbols to conform with CRAN policies.

oppr 0.0.2

CRAN release: 2019-03-20

• CRAN release.

oppr 0.0.1.1

• Fix address sanitizer issues causing CRAN checks to fail.
• Tests successfully complete when the shiny package is not installed.

oppr 0.0.1

CRAN release: 2019-03-18

• CRAN release.

oppr 0.0.0.19

• Add argument to add_heuristic_solver to skip initial step for removing projects and actions that exceed the budget. While this initial step improves solution quality, it is not conventionally used in project prioritization algorithms and so should be omitted to provide accurate benchmarks.

oppr 0.0.0.18

• Reduce precision of extinction probability calculations when formulating a problem with a maximum expected phylogenetic diversity objective (i.e. add_max_phylo_div_objective). Specifically, 1’000 points instead of 10’000 points are now used for piece-wise linear components. It appears that reducing the precision in this manner does not affect the correctness of results, but substantially reduces the time needed to solve problems to optimality in certain situations.

oppr 0.0.0.17

• Update add_heuristic_solver algorithm so that cost-effectiveness values are calculated with projects sharing costs (e.g. if two projects share an action that costs $100, then this action contributes $50 to the cost of each project). This update makes the algorithm similar to backwards heuristics conventionally used in prioritizing species recovery projects (i.e. https://github.com/p-robot/ppp; #14).

oppr 0.0.0.16

• Fix bug in add_heuristic_solver function introduced in version 0.0.0.15.

oppr 0.0.0.15

• Update add_heuristic_solver algorithm so that it removes projects, and not actions, in an iterative fashion. This update (i) makes the algorithm comparable to the backwards heuristics conventionally used in prioritizing species recovery projects (i.e. https://github.com/p-robot/ppp) and (ii) substantially reduces run time (#14).

oppr 0.0.0.14

• Fix bugs in add_heuristic_solver and add_random_solver arising from floating point comparison issue. These were causing infeasible solutions to be returned in R version 3.4.4.

oppr 0.0.0.13

• Fix bug in project_cost_effectiveness reporting incorrect costs, and cost-effectiveness values.

oppr 0.0.0.12

• Assorted documentation tweaks.

oppr 0.0.0.11

• Update add_heuristic_solver algorithm so that all actions and projects which exceed the budget are automatically removed prior to the iterative action removal.
• Update add_random_solver algorithms so that projects are selected instead of individual actions. This means that solutions from this solver are (i) similar to those in previous project prioritization studies and (ii) more likely to deliver better solutions (#13).

oppr 0.0.0.10

• Rename package to oppr since ppr is already on CRAN.
• Fix issue with replacement_costs yielding incorrect results for baseline projects when used with SYMPHONY solvers.

oppr 0.0.0.9

• Add new project_cost_effectiveness function to calculate the cost-effectiveness for each conservation project in a problem.

oppr 0.0.0.8

• Fix typos in documentation (#8).
• The solution_statistics function outputs which projects are completely funded in each solution (#9).
• Add example for saving tabular data to vignette (#10).
• Add examples to vignette for working with the solution output (#11).

oppr 0.0.0.7

• Fix annoying “Found more than one class "tbl_df" in cache; using the first, from namespace 'tibble'” text.

oppr 0.0.0.6

• Actually fix bug when solving problems with a phylogenetic objective and branches that have a constant probability of persistence (#6).
• Fix bug in add_max_phylo_div_objective yielding incorrect solutions when features are ordered differently in the phylogenetic and tabular input data.
• Fix bug in solution_statistics yielding objective values for phylogenetic problems when features are ordered differently in the phylogenetic and tabular input data.
• Fix bug when handling phylogenetic data when a species is associated with two tip branches. Although such data probably indicate errors in the phylogenetic data, this functionality could be useful when combining multiple datasets.

oppr 0.0.0.5

• Add return_data argument to plot_feature_persistence and plot_phylo_persistence so that plotting data can be obtained for creating custom plots.

oppr 0.0.0.4

• Fix bug in add_relative_targets and add_manual_targets (when relative targets supplied) calculations. This result in incorrect calculations.
• Fix issue with expected persistence probabilities not accounting for the “do nothing” scenario (#7).

oppr 0.0.0.3

• The gurobi solver (i.e. add_gurobi_solver function) now uses NumericFocus=3 to help avoid numerical issues.
• The compile function now throws a warning if problems are likely to have numerical issues.

oppr 0.0.0.2

• Fix bug when solving problems with a phylogenetic objective and branches that have a constant probability of persistence (#6). Hindsight shows this attempt did not cover all edge cases.
• Add additional data sanity checks to problem. It will now throw descriptive error messages if features are missing baseline probabilities, or are associated with baseline probabilities below 1e-11.
• Fix unit test for simulate_ptm_data that had a very small chance of failing due to simulating a data set where an action is not associated with any project.
• Feature columns in simulated data produced using simulate_ppp_data and simulate_ptm_data are now sorted.

oppr 0.0.0.1

• Initial commit.