ConstrainedSectorialSearchOptions: Set options for a constrained sectorial search

In paravian/nitro: Integration of TNT in R

Set options for a constrained sectorial search

Description

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

Super class

nitro::AbstractSectorialSearchOptions -> ConstrainedSectorialSearchOptions

Active bindings

min_fork

An integer value indicating the minimum fork number to use with constraint-based sectorial searches.

max_fork

An integer value indicating the maximum fork number to use with constraint-based sectorial searches.

rounds

An integer value indicating the number of times to cycle over groups in constraint-based selections.

Methods

Public methods

• ConstrainedSectorialSearchOptions$new()

• ConstrainedSectorialSearchOptions$print()

• ConstrainedSectorialSearchOptions$queue()

• ConstrainedSectorialSearchOptions$clone()

---

Method new()

Usage

ConstrainedSectorialSearchOptions$new(
  min_fork = 10,
  max_fork = 10,
  rounds = 3,
  buffer = TRUE,
  slack = 0
)

Arguments

min_fork

An integer value indicating the minimum fork number to use with constraint-based sectorial searches.

max_fork

An integer value indicating the maximum fork number to use with constraint-based sectorial searches.

rounds

An integer value indicating the number of times to cycle over groups in constraint-based selections.

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

ConstrainedSectorialSearchOptions$print(...)

Arguments

...

Ignored.

---

Method queue()

Usage

ConstrainedSectorialSearchOptions$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

ConstrainedSectorialSearchOptions$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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