Package index

Application

Main functions and documentation for the application.

wheretowork wheretowork-package: wheretowork: Systematic conservation planning application.

run_app(): Run the Shiny Application

get_golem_config(): Read App Configuration

Functions for sidebar panes.

mapManagerSidebarPane(): Map manager sidebar pane

newSolutionSidebarPane(): New solution sidebar pane

solutionResultsSidebarPane(): Solution results sidebar pane

exportSidebarPane(): Export sidebar pane

contactSidebarPane(): Contact sidebar pane

acknowledgmentsSidebarPane(): Acknowledgments sidebar pane

Functions for creating and updating the widget.

importSettings(): Import settings

importSettingsOutput() renderImportSettings(): Shiny bindings for importSettings

updateImportSettings(): Update import settings widget

cleanImportSettings(): Clean import settings widget

Functions for creating and updating the widget.

solutionSettings(): Solution settings widget

updateSolutionSettings(): Update solution settings widget

solutionSettingsOutput() renderSolutionSettings(): Shiny bindings for solutionSettings

Functions for creating and updating the widget.

mapManager(): Map manager

mapManagerOutput() renderMapManager(): Shiny bindings for mapManager

addMapManagerLayer(): Add a layer in a map manager widget

dropMapManagerLayer(): Drop a layer from a map manager widget

updateMapManagerOrder(): Update map manager widget ordering

updateMapManagerLayer(): Update a layer in a map manager widget

Functions for creating and updating the widget.

solutionResults(): Solution results

solutionResultsOutput() renderSolutionResults(): Shiny bindings for solutionResults

addSolutionResults(): Add a solution results

dropSolutionResults(): Drop a solution results

showSolutionResults(): Show solution results

User interface elements

Functions for creating user interface elements.

leaflet_map(): Leaflet map

importModal(): Import modal

helpModal(): Help modal

solutionResultsModal(): Solution results modal

horizontalPickerInput(): Horizontal picker input

Simulate data

Functions for simulating data.

simulate_categorical_legend(): Simulate categorical legend

simulate_continuous_legend(): Simulate continuous legend

simulate_data(): Simulate data

simulate_excludes(): Simulate excludes

simulate_exclude_legend(): Simulate exclude legend

simulate_includes(): Simulate includes

simulate_include_legend(): Simulate include legend

simulate_solution(): Simulate a new solution

simulate_solution_legend(): Simulate solution legend

simulate_themes(): Simulate themes

simulate_weights(): Simulate weights

Class constructors

Functions for generating new objects.

new_categorical_legend(): New categorical legend

new_continuous_legend(): New continuous legend

new_dataset(): New dataset

new_dataset_from_auto(): New dataset from automatic calculations

new_exclude(): New exclude

new_exclude_results(): New exclude results

new_feature(): New feature

new_feature_results(): New feature results

new_include(): New include

new_include_results(): New include results

new_manual_legend(): New manual legend

new_map_manager(): New map manager

new_null_legend(): New null legend

new_parameter(): New parameter

new_provenance(): New Provenance

new_provenance_from_source(): New provenance from source

new_result(): New Result

new_solution(): New solution

new_solution_from_result(): New solution from result

new_solution_settings(): New solution settings

new_statistic(): New statistic

new_theme(): New theme

new_theme_results(): New theme results

new_variable(): New variable

new_variable_from_auto(): New variable from automatic calculations

new_variable_from_metadata(): New variable from metadata

new_weight(): New weight

new_weight_results(): New weight results

Class definitions

Definititions for classes used to organize data.

Result: Result class

ContinuousLegend: Continuous legend class

CategoricalLegend: Categorical legend class

ManualLegend: Manual legend class

NullLegend: NULL legend class

Parameter: Parameter class

Statistic: Statistic class

Dataset: Dataset class

Provenance: Provenance class

Variable: Variable class

Feature: Feature class

Weight: Weight class

Include: Include class

Exclude: Exclude class

Theme: Theme class

Solution: Solution class

SolutionSettings: Solution settings class

MapManager: Map manager class

FeatureResults: Feature results class

WeightResults: Weight results class

IncludeResults: Include results class

ExcludeResults: Exclude results class

ThemeResults: Theme results class

Result functions

Functions used to generate results.

min_set_result(): Generate results using minimum set formulation

min_shortfall_result(): Generate result using minimum shortfall formulation

Project functions

Functions used to work with projects.

read_project(): Read project

write_project(): Write project

find_projects(): Find projects

Validation functions

Functions used to validate files.

is_valid_attribute_file(): Is valid attribute file?

is_valid_boundary_file(): Is valid boundary file?

is_valid_spatial_file(): Is valid spatial file?

is_valid_configuration_file(): Is valid configuration file?

Shiny functions

Functions used to interact with the front-end of the application.

enable_html_element(): Enable a HTML element

disable_html_element(): Disable a HTML element

disable_html_css_selector(): Disable HTML element(s) using a CSS selector

enable_html_css_selector(): Enable a HTML element using a CSS selector

change_file_icon_js(): Change file icon and update tool tip

removeMapPane(): Remove map pane using CSS selector

Spatial functions

Functions for manipulating spatial data.

spatial_data_type(): Spatial data type

spatial_data_statistics(): Spatial data statistics

writeNamedRaster(): Write a Raster object to disk

read_spatial_data(): Read spatial data

write_spatial_data(): Write spatial data

repair_spatial_data(): Repair spatial data

shapefile_field_names(): Shapefile field names

reserve_sizes(): Reserve sizes

calculate_coverage(): Calculate coverage

Miscellaneous functions

color_palette(): Color palette

error_message(): Error message

error_log(): Error log

extract_data_matrix(): Extract data matrix

prepare_fileInput(): Prepare file input

import_data(): Import data

acknowledge_packages(): Acknowledge R packages.

write_excel_workbook(): Write Excel workbook

Application

Sidebar panes

Import settings widget

Solution settings widget

Map manager widget

Solution results widget

User interface elements

Simulate data

Class constructors

Class definitions

Result functions

Project functions

Validation functions

Shiny functions

Spatial functions

Miscellaneous functions