Trait: Class providing object with methods to mimic in silico Traits

In isqg: In Silico Quantitative Genetics

Class providing object with methods to mimic in silico Traits

Description

Mean to mimic a in silico Trait. It is the working instances of the simulator.

Details

Object of R6 class that points to C++ objetcs.

Value

Objects of R6 class with methods to mimic in silico Traits.

Public fields

.ptr

External pointer to the instance of the C++ class Specie.

Methods

Public methods

• .R_Trait_ctor$new()

• .R_Trait_ctor$print()

• .R_Trait_ctor$alpha()

• .R_Trait_ctor$clone()

---

Method new()

Create an instance of a Trait.

Usage

.R_Trait_ctor$new(ptr)

Arguments

ptr

an Smart pointer to an instance of a Trait C++ class.

Returns

A new 'Trait' object.

---

Method print()

Print/Show an instance of the Trait class.

Usage

.R_Trait_ctor$print(...)

Arguments

...

further arguments to be passed to print.

---

Method alpha()

Evaluates the breeding value.

Usage

.R_Trait_ctor$alpha(gid)

Arguments

gid

an instance of the class Specimen.

Returns

the breeding value of the given specimen for the trait.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

.R_Trait_ctor$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

isqg documentation built on Oct. 18, 2022, 9:07 a.m.