isqg (version 1.4)

Specie: Class providing object with methods to mimic in silico Genomes

Description

Mean to mimic a in silico Genomes. It is the machine instances of the simulator.

Value

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

Public fields

.ptr

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

Methods

Public methods

• .R_Specie_ctor$new()

• .R_Specie_ctor$print()

• .R_Specie_ctor$founder()

• .R_Specie_ctor$gamete()

• .R_Specie_ctor$map()

• .R_Specie_ctor$clone()

---

Method new()

Create an instance of a Specie.

Usage

.R_Specie_ctor$new(ptr)

Arguments

ptr

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

Returns

A new `Specie` object.

---

Method print()

Print/Show an instance of the Specie class.

Usage

.R_Specie_ctor$print(...)

Arguments

...

further arguments to be passed to print.

---

Method founder()

Constructor of a Founder Instances of the Specimen Class

Usage

.R_Specie_ctor$founder(code)

Arguments

code

a length one character vector with one of the genotype codes: "AA", "Aa", "aA" or "aa".

---

Method gamete()

Generate gamete prototypes for this specie.

Usage

.R_Specie_ctor$gamete(n)

Arguments

n

an integer number with the number of gametes prototype to be generated.

Returns

a vector of strings with the gamete prototypes.

---

Method map()

Retrieve the map of the current specie.

Usage

.R_Specie_ctor$map()

Returns

a data.frame with the map of the specie.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

.R_Specie_ctor$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Details

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