simulateEvolution: Run an entire simulation with flags

In retrocombinator: Simulating the Molecular Evolutionary Process of Retrotransposon Recombination

Description

Run an entire simulation with flags

Usage

simulateEvolution(
  sequenceParams = SequenceParams(),
  activityParams = ActivityParams(),
  mutationParams = MutationParams(),
  burstParams = BurstParams(),
  recombParams = RecombParams(),
  selectionParams = SelectionParams(),
  familyParams = FamilyParams(),
  simulationParams = SimulationParams(),
  outputParams = OutputParams(),
  seedParams = SeedParams()
)

Arguments

sequenceParams	A [retrocombinator::SequenceParams()] object for the simulation
activityParams	An [retrocombinator::ActivityParams()] object for the simulation
mutationParams	A [retrocombinator::MutationParams()] object for the simulation
burstParams	A [retrocombinator::BurstParams()] object for the simulation
recombParams	A [retrocombinator::RecombParams()] object for the simulation
selectionParams	A [retrocombinator::SelectionParams()] object for the simulation
familyParams	A [retrocombinator::FamilyParams()] object for the simulation
simulationParams	A [retrocombinator::SimulationParams()] object for the simulation
outputParams	A [retrocombinator::OutputParams()] object for the simulation
seedParams	A [retrocombinator::SeedParams()] object for the simulation

Value

A single character, the filename of the output of the simulation that can then be loaded into R using [retrocombinator::parseSimulationOutput()]

Examples

## Not run: 
simulateEvolution(sequenceParams = mySequenceParams,
                  familyParams = myFamilyParams)

## End(Not run)

retrocombinator documentation built on Nov. 12, 2021, 1:07 a.m.