Learn R Programming

jaatha (version 2.7.0)

addFeature: Low level function for adding a new feature to a demographic Model

Description

Use this function to add a feature to a dm if there is no higher level "dm.add*"-function availible.

Usage

addFeature(dm, type, parameter = NA, lower.range = NA, upper.range = NA,
  fixed.value = NA, par.new = T, pop.source = NA, pop.sink = NA,
  time.point = NA, group = 0, variance = 0, zero.inflation = 0)

Arguments

dm
The demographic model to which the feature will be added
type
The type of the feature coded as a character
parameter
Either the name of the parameter (par.new=TRUE), or an R expression possibly containing one or more previously created parameter names.
lower.range
The lower boundary for the value of the parameter
upper.range
The upper boundary for the value of the parameter
fixed.value
If given, the parameter will be set to a fixed value. This is equivalent to seting lower.range equal to upper.range.
par.new
If 'TRUE' a new parameter will be created using the arguments 'lower.range' and 'upper.range' or 'fixed.value'. It will be named 'parameter'. If 'FALSE' the argument 'parameter' will be evaluated instead.
pop.source
The source population if availible (think e.g. of migration)
pop.sink
The target or "sink" population if availible (think e.g. of migration)
time.point
Normally the point in backwards time where the feature starts.
group
For genomic features, different groups can be created.
variance
Set to a value different from 0 to introduce variation in the the parameter value for different loci. The variation follows a gamma distribution with mean equal to the value provided as parameter, and variance as given here. Can also be set t
zero.inflation
If used, a zero inflated gamma distribution is used to model the variablility between loci. This parameter should evluate to the percent of loci for which the parameter is 0. The values for all other loci will be drawn from the discretized gamma distribut

Value

  • The extended demographic model.