famSizeCal: famSizeCal A function to calculate the total number of...
In R-Computing-Lab/BGMisc: An R Package for Extended Behavior Genetics Analysis
View source: R/calculateFamilySize.R
famSizeCal R Documentation
famSizeCal
A function to calculate the total number of individuals in a pedigree given parameters. This is a supporting function for function simulatePedigree
Description
famSizeCal
A function to calculate the total number of individuals in a pedigree given parameters. This is a supporting function for function simulatePedigree
Usage
famSizeCal(kpc, Ngen, marR)
Arguments
kpc
Number of kids per couple (integer >= 2).
Ngen
Number of generations (integer >= 1).
marR
Mating rate (numeric value ranging from 0 to 1).
Value
Returns a numeric value indicating the total pedigree size.
R-Computing-Lab/BGMisc documentation built on April 3, 2025, 3:12 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/calculateFamilySize.R
| famSizeCal | R Documentation |
famSizeCal
A function to calculate the total number of individuals in a pedigree given parameters. This is a supporting function for function simulatePedigree
Description
famSizeCal
A function to calculate the total number of individuals in a pedigree given parameters. This is a supporting function for function simulatePedigree
Usage
famSizeCal(kpc, Ngen, marR)
Arguments
kpc |
Number of kids per couple (integer >= 2). |
Ngen |
Number of generations (integer >= 1). |
marR |
Mating rate (numeric value ranging from 0 to 1). |
Value
Returns a numeric value indicating the total pedigree size.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.