create.PopGenome.method: Integration of own functions into the PopGenome-framework

Description Usage Arguments Details Examples

View source: R/create.PopGenome.method.R

Description

This function generates a skeleton for a PopGenome function. It thereby facilitates the effortless integration of new methods into the PopGenome framework.

Usage

1
create.PopGenome.method(function.name,population.specific=TRUE)

Arguments

function.name

name of your function

population.specific

TRUE:function returns one value per population.FALSE:function returns one value calculated across all populations (as in the case of FST measurements)

Details

This mechanism enables you to use your own functions in the PopGenome environment. The functions can also be applied to sliding windows or subsites.
Please look at the generated function, which documents where to place your own function in detail.

Examples

1
2
3
4
5
6
# GENOME.class <- readData(".../Alignments")
# create.PopGenome.method("myFunction")
# edit myFunction.R
# source("myFunction")
# value <- myFunction(test)
# value

PopGenome documentation built on Feb. 1, 2020, 1:07 a.m.