Result: Result class

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

Result class

Description

Result class

Result class

Details

Definition for the Result class.

Public fields

id

character value.

values

numeric vector.

area

numeric value.

perimeter

numeric value or NA_real_.

theme_coverage

numeric value.

weight_coverage

numeric value.

include_coverage

numeric value.

exclude_coverage

numeric value.

theme_settings

data.frame object.

weight_settings

data.frame object.

include_settings

data.frame object.

exclude_settings

data.frame object.

parameters

list of Parameter objects.

Methods

Public methods

• Result$new()

• Result$print()

• Result$repr()

• Result$clone()

---

Method new()

Create a new Result object.

Usage

Result$new(
  id,
  values,
  area,
  perimeter,
  theme_coverage,
  weight_coverage,
  include_coverage,
  exclude_coverage,
  theme_settings,
  weight_settings,
  include_settings,
  exclude_settings,
  parameters
)

Arguments

id

character value.

values

numeric vector.

area

numeric value.

perimeter

numeric value or NA_real_.

theme_coverage

numeric vector.

weight_coverage

numeric vector.

include_coverage

numeric vector.

exclude_coverage

numeric vector.

theme_settings

logical value.

weight_settings

tbl_df data frame.

include_settings

tbl_df data frame.

exclude_settings

tbl_df data frame.

parameters

list of Parameter objects.

Returns

A new Result object.

---

Method print()

Print the object.

Usage

Result$print(...)

Arguments

...

not used.

---

Method repr()

Generate a character summarizing the representation of the object.

Usage

Result$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 clone()

The objects of this class are cloneable with this method.

Usage

Result$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

new_result().

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