breedr_effect: Constructor for a generic breedR effect

Description Usage Arguments Details Value

View source: R/breedr_effect.R

Description

The breedr_effect-class is virtual. No object should be directly created with this constructor. This constructor is to be called from within non-virtual subclasses like generic, diagonal, spatial or additive_genetic.

Usage

1
2
3
4
breedr_effect(incidence)

## S3 method for class 'breedr_effect'
dim(x)

Arguments

incidence

matrix-like object

x

A breedr_effect.

Details

This constructor performs the arguments checks. But the implementation details (i.e., storage format and handling) is left for the subclasses.

Value

A list with a single element incidence.matrix.


famuvie/breedR documentation built on Sept. 6, 2021, 4:50 a.m.