ExclusiveSectorialSearchOptions: Set options for an exclusive sectorial search

In paravian/nitro: Integration of TNT in R

Set options for an exclusive sectorial search

Description

ExclusiveSectorialSearchOptions is an R6 class that defines the set of options required to perform exclusive sectorial searching analyses in nitro.

Super class

nitro::AbstractSectorialSearchOptions -> ExclusiveSectorialSearchOptions

Active bindings

selections

An integer value indicating the number of exclusive (i.e., non-overlapping) sectors to subdivide the entire tree into.

rounds

An integer value indicating the number of times to repeat exclusive sector selection and analysis.

Methods

Public methods

• ExclusiveSectorialSearchOptions$new()

• ExclusiveSectorialSearchOptions$print()

• ExclusiveSectorialSearchOptions$queue()

• ExclusiveSectorialSearchOptions$clone()

---

Method new()

Usage

ExclusiveSectorialSearchOptions$new(
  selections,
  rounds = 2,
  buffer = TRUE,
  slack = 0
)

Arguments

selections

An integer value indicating the number of exclusive (i.e., non-overlapping) sectors to subdivide the entire tree into.

rounds

An integer value indicating the number of times to repeat exclusive sector selection and analysis.

buffer

A logical value indicating whether to use an independent memory buffer for analysis of sectors.

slack

An integer value indicating the percentage to increase the available memory during searches.

---

Method print()

Usage

ExclusiveSectorialSearchOptions$print(...)

Arguments

...

Ignored.

---

Method queue()

Usage

ExclusiveSectorialSearchOptions$queue(set_only = FALSE)

Arguments

set_only

A logical indicating whether to instruct the command to execute immediately (TRUE) or set the variables for future execution (FALSE, default).

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ExclusiveSectorialSearchOptions$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

paravian/nitro documentation built on Jan. 17, 2025, 11:21 p.m.