ThemeResults: Theme results class

In NCC-CNC/wheretowork: Interactive Systematic Conservation Planning Application

Theme results class

Description

Theme results class

Theme results class

Details

Definition for the ThemeResults class.

Public fields

id

character value.

theme

Theme object.

feature_results

list of FeatureResults objects.

Methods

Public methods

• ThemeResults$new()

• ThemeResults$print()

• ThemeResults$repr()

• ThemeResults$get_results_data()

• ThemeResults$get_widget_data()

• ThemeResults$clone()

---

Method new()

Create a new ThemeResults object.

Usage

ThemeResults$new(id, theme, feature_results)

Arguments

id

character value.

theme

'Theme object.

feature_results

list of FeatureResults objects.

Returns

A new ThemeResults object.

---

Method print()

Print the object.

Usage

ThemeResults$print(...)

Arguments

...

not used.

---

Method repr()

Generate a character summarizing the representation of the object.

Usage

ThemeResults$repr(start = "[", end = "]")

Arguments

start

character symbol used to start the setting list. Defaults to "[".

end

character symbol used to start the setting list. Defaults to "]".

Returns

character value.

---

Method get_results_data()

Get results.

Usage

ThemeResults$get_results_data()

Returns

tibble::tibble() object.

---

Method get_widget_data()

Get data for displaying the object in a solutionResults() widget.

Usage

ThemeResults$get_widget_data()

Returns

list with widget data.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ThemeResults$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

new_theme_results().

NCC-CNC/wheretowork documentation built on Feb. 27, 2025, 6:11 p.m.