API for multiscape
Multi-Action, Multi-Objective Spatial Planning

Global functions
%>% Man page
.get_dist_benefit_model_from_effects Source code
.get_dist_effects_model Source code
.is_raster_path Source code
.mo_abort Source code
.mo_get_solution_from Source code
.onLoad Source code
.onUnload Source code
.pa_abort Source code
.pa_action_cardinality_covered_pu Source code
.pa_action_cardinality_upper_bounds Source code
.pa_action_names_from_internal_ids Source code
.pa_action_relation_actions Source code
.pa_action_set_identifiers Source code
.pa_action_weights_vector Source code
.pa_actions_summary Source code
.pa_active_objective_alias Source code
.pa_add_action_labels Source code
.pa_add_action_relation Source code
.pa_add_feature_labels Source code
.pa_add_implicit_conservation_model Source code
.pa_add_linear_constraint Source code
.pa_append_summary_tables Source code
.pa_apply_action_cardinality_if_present Source code
.pa_apply_action_max_per_pu_default Source code
.pa_apply_action_relations_if_present Source code
.pa_apply_aggregate_targets Source code
.pa_apply_area_constraints_if_present Source code
.pa_apply_budget_constraints_if_present Source code
.pa_apply_group_area_constraints_if_present Source code
.pa_apply_runtime_updates_to_model Source code
.pa_apply_solver_capabilities Source code
.pa_apply_targets_if_present Source code
.pa_as_int_id Source code
.pa_as_single_solution_set Source code
.pa_assert_unconfigured Source code
.pa_bind_rows_fill Source code
.pa_build_effect_losses Source code
.pa_build_joint_effects Source code
.pa_build_model Man page Source code
.pa_build_model_apply_constraints Source code
.pa_build_model_build_cpp_core Source code
.pa_build_model_ensure_implicit_conservation Source code
.pa_build_model_ensure_tables Source code
.pa_build_model_finalize Source code
.pa_build_model_init_needs Source code
.pa_build_model_prepare_needs_cpp Source code
.pa_build_model_prepare_tables Source code
.pa_build_model_set_needs_from_objective Source code
.pa_build_model_set_objective_cpp Source code
.pa_build_model_validate_locked_in_action_feasibility Source code
.pa_build_model_validate_objective_requirements Source code
.pa_build_model_validate_pipeline_state Source code
.pa_cardinality_available_pairs Source code
.pa_cardinality_count Source code
.pa_cardinality_ids Source code
.pa_cbc_complete_dimensions Source code
.pa_check_solution_append_compatible Source code
.pa_clean_solution_summary Source code
.pa_cli_box_chars Source code
.pa_cli_theme Source code
.pa_clone_data Source code
.pa_clone_solution_set Source code
.pa_compare_problem_object Source code
.pa_compare_problem_table Source code
.pa_compile_problem Source code
.pa_constraint_name Source code
.pa_constraints_summary Source code
.pa_coords_from_input Source code
.pa_create_problem_raster_cells_impl Source code
.pa_create_problem_tabular_impl Source code
.pa_data_solver_text Source code
.pa_data_status_text Source code
.pa_deep_copy_list Source code
.pa_deepcopy_data Source code
.pa_deprecate_arg Source code
.pa_drop_run_id_if_solution_id_present Source code
.pa_effect_loss_key Source code
.pa_effect_scopes Source code
.pa_effects_summary Source code
.pa_empty_action_sets Source code
.pa_ensure_model_snapshot Source code
.pa_ensure_pu_index Source code
.pa_eval_aggregate_effect_objective Source code
.pa_extract_solution_tables Source code
.pa_fast_extract Source code
.pa_feasible_status_values Source code
.pa_feature_names_from_internal_ids Source code
.pa_feature_potential Source code
.pa_feature_totals Source code
.pa_features_summary Source code
.pa_filter_solution_set Source code
.pa_filter_summary_by_solution Source code
.pa_finalize_solution_ids Source code
.pa_find_selection_column Source code
.pa_finish_joint_effects Source code
.pa_frontier_distance Source code
.pa_fun_from_name Source code
.pa_get_action_cost_vec Source code
.pa_get_area_vec Source code
.pa_get_cost_vec Source code
.pa_get_objective_matrix Source code
.pa_get_objectives_internal Source code
.pa_get_pu_sf_aligned Source code
.pa_get_selection_long Source code
.pa_get_selection_matrix Source code
.pa_get_solve_args Source code
.pa_get_stored_run_ids Source code
.pa_get_stored_solution_ids Source code
.pa_group_equal_vectors Source code
.pa_has_coords Source code
.pa_has_joint_effects Source code
.pa_has_model Source code
.pa_has_sf Source code
.pa_is_raster_path Source code
.pa_is_vector_path Source code
.pa_joint_effects_input Source code
.pa_joint_objective_terms Source code
.pa_joint_objective_vector Source code
.pa_joint_selected_features Source code
.pa_knee_angle_score_2d Source code
.pa_knee_distance_score_2d Source code
.pa_linkage_objectives Source code
.pa_linkage_pair_objectives Source code
.pa_log_add Source code
.pa_make_solution_ids Source code
.pa_member_key Source code
.pa_meseta_preview_maps Source code
.pa_method_summary Source code
.pa_minimum_spanning_pairs Source code
.pa_model_aux_summary Source code
.pa_model_checks_text Source code
.pa_model_dims Source code
.pa_model_frag_vars_summary Source code
.pa_model_from_ptr Source code
.pa_model_is_current Source code
.pa_n_of_total_text Source code
.pa_needs_default Source code
.pa_needs_implicit_conservation_model Source code
.pa_normalize_min_objective_matrix Source code
.pa_normalize_object_for_compare Source code
.pa_normalize_table_for_compare Source code
.pa_nrow0 Source code
.pa_num_text Source code
.pa_numeric_vectors_equal Source code
.pa_objective_distance_matrix Source code
.pa_objectives_summary Source code
.pa_parse_targets Source code
.pa_pct_text Source code
.pa_planning_unit_changes Source code
.pa_plot_spatial_get_geometry Source code
.pa_plot_spatial_make_base_plot Source code
.pa_plot_spatial_resolve_runs Source code
.pa_plot_spatial_resolve_solutions Source code
.pa_positive_objective_scale Source code
.pa_prepare_joint_effects_model Source code
.pa_prepare_linkage_pairs Source code
.pa_prepare_solution_groups Source code
.pa_preview_text Source code
.pa_print_built_model_section Source code
.pa_print_model_section Source code
.pa_rbind_fill Source code
.pa_read_rast Source code
.pa_read_vect Source code
.pa_refresh_model_snapshot Source code
.pa_register_objective Source code
.pa_remap_solution_set_tables Source code
.pa_resolve_action_subset Source code
.pa_resolve_feature_subset Source code
.pa_resolve_solution_arg Source code
.pa_safe_range Source code
.pa_set_active_and_register_objective Source code
.pa_solution_alias_values_summary Source code
.pa_solution_append_solutionset Source code
.pa_solution_decision_groups Source code
.pa_solution_objective_groups Source code
.pa_solution_status_class Source code
.pa_solution_status_inline Source code
.pa_solutionset_aliases Source code
.pa_solutionset_method_label Source code
.pa_solutionset_objective_ranges Source code
.pa_solutionset_processing_summary Source code
.pa_solutionset_range_text Source code
.pa_solutionset_run_columns Source code
.pa_solutionset_run_design_summary Source code
.pa_solutionset_solution_counts Source code
.pa_solutionset_status_summary Source code
.pa_solve_single_problem Source code
.pa_spatial_relations_summary Source code
.pa_store_area_constraints Source code
.pa_store_budget_constraints Source code
.pa_store_relation Source code
.pa_store_targets Source code
.pa_strip_nested_solution_problems Source code
.pa_subset_to_string Source code
.pa_swap_edges Source code
.pa_target_actions Source code
.pa_targets_summary Source code
.pa_uses_aggregate_effects Source code
.pa_validate_action_cardinality_model Source code
.pa_validate_action_cardinality_specs Source code
.pa_validate_action_relations_specs Source code
.pa_validate_action_sets Source code
.pa_validate_positive_integer_ids Source code
.pa_validate_relation Source code
.pamo_activate_ir_as_single_objective Source code
.pamo_add_alias_upper_bound_constraint Source code
.pamo_add_augmecon_slacks Source code
.pamo_apply_augmecon_constraint Source code
.pamo_apply_augmecon_objective Source code
.pamo_apply_epsilon_constraint Source code
.pamo_apply_single_objective Source code
.pamo_apply_weighted_objective Source code
.pamo_augmecon_grid_to_manual_df Source code
.pamo_bind_solution_summaries Source code
.pamo_build_auto_augmecon_runs Source code
.pamo_build_auto_epsilon_runs Source code
.pamo_check_mo_control Source code
.pamo_check_run_design Source code
.pamo_check_secondary_values Source code
.pamo_cli_done Source code
.pamo_cli_enabled Source code
.pamo_cli_header Source code
.pamo_cli_step Source code
.pamo_cli_warn Source code
.pamo_clone_base Source code
.pamo_compile_augmecon_manual_runs Source code
.pamo_compile_augmecon_runs Source code
.pamo_compile_epsilon_manual_runs Source code
.pamo_compile_epsilon_runs Source code
.pamo_compile_problem Source code
.pamo_compile_superset_spec Source code
.pamo_compile_weighted_grid_runs Source code
.pamo_compile_weighted_manual_runs Source code
.pamo_compile_weighted_runs Source code
.pamo_compute_epsilon_extremes_2obj Source code
.pamo_compute_secondary_range_against_primary Source code
.pamo_compute_weighted_ranges Source code
.pamo_eps_to_manual_df Source code
.pamo_eval_action_boundary_cut_on_solution Source code
.pamo_eval_alias_canonical_on_solution Source code
.pamo_eval_alias_on_solution Source code
.pamo_eval_boundary_cut_on_solution Source code
.pamo_eval_intervention_impact_on_solution Source code
.pamo_extract_solution Source code
.pamo_failed_run Source code
.pamo_get_alias_value_from_solution Source code
.pamo_get_objective_spec Source code
.pamo_get_objective_specs Source code
.pamo_get_solution_vector Source code
.pamo_get_specs Source code
.pamo_is_run_design Source code
.pamo_is_run_grid Source code
.pamo_is_run_manual Source code
.pamo_model_obj_length Source code
.pamo_normalize_vec Source code
.pamo_objective_to_ir Source code
.pamo_objvec_action_boundary_cut Source code
.pamo_objvec_from_ir Source code
.pamo_prepare_relation_model Source code
.pamo_prepare_superset_model Source code
.pamo_refine_augmecon Source code
.pamo_simplex_integer_compositions Source code
.pamo_solve_augmecon Source code
.pamo_solve_epsilon_constraint Source code
.pamo_solve_one Source code
.pamo_solve_one_or_keep_failed Source code
.pamo_solve_weighted Source code
.pamo_solver_error_status Source code
.pamo_validate_manual_weight_design Source code
.pamo_validate_objectives Source code
.pamo_validate_weighted_design Source code
.sum_incident_by_pu Source code
.validate_split_effects Source code
Problem Man page
SolutionSet Man page
`%||%` Source code
add_action_max_per_pu Man page Source code
add_action_sets Man page Source code
add_actions Man page Source code
add_benefits Man page Source code
add_constraint_action_cardinality Man page Source code
add_constraint_action_excludes Man page Source code
add_constraint_action_requires Man page Source code
add_constraint_action_together Man page Source code
add_constraint_area Man page Source code
add_constraint_budget Man page Source code
add_constraint_locked_actions Man page Source code
add_constraint_locked_planning_units Man page Source code
add_constraint_locked_pu Man page Source code
add_constraint_targets_absolute Man page Source code
add_constraint_targets_relative Man page Source code
add_effects Man page Source code
add_losses Man page Source code
add_objective_max_benefit Man page Source code
add_objective_max_effect Man page Source code
add_objective_max_net_profit Man page Source code
add_objective_max_profit Man page Source code
add_objective_min_cost Man page Source code
add_objective_min_effect Man page Source code
add_objective_min_fragmentation_action Man page Source code
add_objective_min_fragmentation_planning_units Man page Source code
add_objective_min_fragmentation_pu Man page Source code
add_objective_min_intervention_impact Man page Source code
add_objective_min_loss Man page Source code
add_profit Man page Source code
add_spatial_boundary Man page Source code
add_spatial_distance Man page Source code
add_spatial_knn Man page Source code
add_spatial_queen Man page Source code
add_spatial_relations Man page Source code
add_spatial_rook Man page Source code
available_to_solve Source code
compile_model Man page Source code
compile_model.Problem Man page Source code
create_problem Man page
create_problem,ANY,ANY,NULL-method Man page
create_problem,ANY,ANY,missing-method Man page
create_problem,ANY,data.frame,data.frame-method Man page
create_problem,data.frame,data.frame,data.frame-method Man page
frontier_distances Man page Source code
frontier_extremes Man page Source code
frontier_knee Man page Source code
frontier_neighbors Man page Source code
getStatus Source code
get_action_sets Man page Source code
get_actions Man page Source code
get_features Man page Source code
get_objective_specs Source code
get_objectives Man page Source code
get_planning_units Man page Source code
get_pu Man page Source code
get_runs Man page Source code
get_solution_states Man page Source code
get_solution_vector Source code
get_targets Man page Source code
linkage_contrasts Man page Source code
linkage_distances Man page Source code
linkage_transition Man page Source code
linkage_turnover Man page Source code
load_ecosystem_services Man page Source code
load_meseta Man page Source code
load_sim_features_raster Man page Source code
load_sim_multiaction Man page Source code
mo_control Man page Source code
no_extra_arguments Source code
plot_spatial Source code
plot_spatial_actions Man page Source code
plot_spatial_features Man page Source code
plot_spatial_planning_units Man page Source code
plot_spatial_pu Man page Source code
plot_tradeoff Man page Source code
pproto Source code
print Man page
print.Problem Man page Source code
print.SolutionSet Man page Source code
print.multiscape_linkage_transition Man page Source code
problem-class Man page
rcpp_add_action_locks Source code
rcpp_add_action_max_per_pu Source code
rcpp_add_base_variables Source code
rcpp_add_effect_loss_variables Source code
rcpp_add_effect_selection_variables Source code
rcpp_add_joint_effect_variables Source code
rcpp_add_linear_constraint Source code
rcpp_add_linking_w_le_sum_x Source code
rcpp_add_linking_x_le_w Source code
rcpp_add_linking_z_le_w Source code
rcpp_add_objective_max_benefit Source code
rcpp_add_objective_max_net_profit Source code
rcpp_add_objective_max_profit Source code
rcpp_add_objective_min_cost Source code
rcpp_add_objective_min_fragmentation Source code
rcpp_add_objective_min_fragmentation_actions Source code
rcpp_add_objective_min_intervention_impact Source code
rcpp_add_objective_min_loss Source code
rcpp_add_pu_locks Source code
rcpp_add_target_recovery Source code
rcpp_get_optimization_problem_A Source code
rcpp_get_optimization_problem_ncell Source code
rcpp_get_optimization_problem_ncol Source code
rcpp_get_optimization_problem_nrow Source code
rcpp_model_add_columns Source code
rcpp_model_set_objective_vector Source code
rcpp_new_optimization_problem Source code
rcpp_optimization_problem_as_list Source code
rcpp_prepare_objective_max_benefit Source code
rcpp_prepare_objective_max_net_profit Source code
rcpp_prepare_objective_max_profit Source code
rcpp_prepare_objective_min_cost Source code
rcpp_prepare_objective_min_fragmentation Source code
rcpp_prepare_objective_min_fragmentation_actions Source code
rcpp_prepare_objective_min_intervention_impact Source code
rcpp_prepare_objective_min_loss Source code
rcpp_reset_objective Source code
register_atomic_objective_internal Man page
run_grid Man page Source code
run_manual Man page Source code
selection_consistency Man page Source code
selection_frequency Man page Source code
selection_similarity Man page Source code
set_method_augmecon Man page Source code
set_method_epsilon_constraint Man page Source code
set_method_weighted_sum Man page Source code
set_runs_control Man page Source code
set_runs_grid Man page Source code
set_runs_manual Man page Source code
set_solver Man page Source code
set_solver_cbc Man page Source code
set_solver_cplex Man page Source code
set_solver_gurobi Man page Source code
set_solver_symphony Man page Source code
show Man page
show,Problem-method Man page
show,Solution-method Man page
show,SolutionSet-method Man page
sim_dist_features Man page
sim_features Man page
sim_multiaction Man page
sim_pu Man page
sim_pu_sf Man page
solution_append Man page Source code
solution_filter Man page Source code
solution_unique Man page Source code
solutionset-class Man page
solve Man page Source code
solve.Problem Man page Source code
spatial_relations Man page
multiscape documentation built on Oct. 12, 2026, 5:08 p.m.