Package: coala 0.7.2

Dirk Metzler

coala: A Framework for Coalescent Simulation

Coalescent simulators can rapidly simulate biological sequences evolving according to a given model of evolution. You can use this package to specify such models, to conduct the simulations and to calculate additional statistics from the results (Staab, Metzler, 2016 <doi:10.1093/bioinformatics/btw098>). It relies on existing simulators for doing the simulation, and currently supports the programs 'ms', 'msms' and 'scrm'. It also supports finite-sites mutation models by combining the simulators with the program 'seq-gen'. Coala provides functions for calculating certain summary statistics, which can also be applied to actual biological data. One possibility to import data is through the 'PopGenome' package (<https://github.com/pievos101/PopGenome>).

Authors:Paul Staab [aut], Dirk Metzler [aut, ths, cre], Jorge E. Amaya Romero [ctb]

coala_0.7.2.tar.gz
coala_0.7.2.zip(r-4.5)coala_0.7.2.zip(r-4.4)coala_0.7.2.zip(r-4.3)
coala_0.7.2.tgz(r-4.4-x86_64)coala_0.7.2.tgz(r-4.4-arm64)coala_0.7.2.tgz(r-4.3-x86_64)coala_0.7.2.tgz(r-4.3-arm64)
coala_0.7.2.tar.gz(r-4.5-noble)coala_0.7.2.tar.gz(r-4.4-noble)
coala_0.7.2.tgz(r-4.4-emscripten)coala_0.7.2.tgz(r-4.3-emscripten)
coala.pdf |coala.html
coala/json (API)
NEWS

# Install 'coala' in R:
install.packages('coala', repos = c('https://statgenlmu.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/statgenlmu/coala/issues

Uses libs:
  • c++– GNU Standard C++ Library v3

On CRAN:

coalescentdnaevolutionpopgensimulation

7.06 score 22 stars 86 scripts 361 downloads 64 exports 8 dependencies

Last updated 9 months agofrom:017fbc7ad8. Checks:OK: 3 NOTE: 6. Indexed: yes.

TargetResultDate
Doc / VignettesOKOct 31 2024
R-4.5-win-x86_64OKOct 31 2024
R-4.5-linux-x86_64OKOct 31 2024
R-4.4-win-x86_64NOTEOct 31 2024
R-4.4-mac-x86_64NOTEOct 31 2024
R-4.4-mac-aarch64NOTEOct 31 2024
R-4.3-win-x86_64NOTEOct 31 2024
R-4.3-mac-x86_64NOTEOct 31 2024
R-4.3-mac-aarch64NOTEOct 31 2024

Exports:activate_msactivate_msmsactivate_scrmactivate_seqgenas.segsitescalc_sumstats_from_datacheck_modelcoal_modelcreate_abc_paramcreate_abc_sumstatcreate_segsitesfeat_growthfeat_ignore_singletonsfeat_migrationfeat_mutationfeat_outgroupfeat_pop_mergefeat_recombinationfeat_selectionfeat_size_changefeat_unphasedget_featuresget_locus_lengthget_locus_length_matrixget_locus_numberget_outgroupget_outgroup_sizeget_parameterget_parameter_tableget_population_individualsget_populationsget_positionsget_sample_sizeget_snpsget_summary_statisticsget_trio_locusis_segsiteslist_simulatorslocus_averagedlocus_singlelocus_triopar_constpar_exprpar_namedpar_priorpar_rangepar_variationpar_zero_inflationscale_modelset_positionsset_trio_locussumstat_classsumstat_dnasumstat_filesumstat_four_gametesumstat_ihhsumstat_jsfssumstat_mcmfsumstat_nucleotide_divsumstat_omegasumstat_seg_sitessumstat_sfssumstat_tajimas_dsumstat_trees

Dependencies:assertthatdigestR6RcppRcppArmadillorehhrehh.datascrm

Adding Summary Statistics and Simulators

Rendered fromcoala-extend.Rmdusingknitr::rmarkdownon Oct 31 2024.

Last update: 2024-03-03
Started: 2015-11-11

Examples

Rendered fromcoala-examples.Rmdusingknitr::rmarkdownon Oct 31 2024.

Last update: 2024-03-03
Started: 2016-02-02

Importing Genetic Data into Coala

Rendered fromcoala-data-import.Rmdusingknitr::rmarkdownon Oct 31 2024.

Last update: 2024-03-03
Started: 2015-12-01

Introduction to Coala

Rendered fromcoala-intro.Rmdusingknitr::rmarkdownon Oct 31 2024.

Last update: 2024-03-03
Started: 2015-11-11

Using Coala for Approximate Bayesian Computation

Rendered fromcoala-abc.Rmdusingknitr::rmarkdownon Oct 31 2024.

Last update: 2024-03-03
Started: 2015-11-11

Using External Simulators

Rendered fromcoala-install.Rmdusingknitr::rmarkdownon Oct 31 2024.

Last update: 2024-03-03
Started: 2015-11-11

Readme and manuals

Help Manual

Help pageTopics
A Framework for Coalescent Simulation in Rcoala-package coala
Convert genetic data to coala's internal formatas.segsites
Convert PopGenome Data into Coala's Formatas.segsites.GENOME
Calculate summary statistics for biological datacalc_sumstats_from_data
Check which simulator can simulate a modelcheck_model
Create a Coalescent Modelcoalmodelpart coal_model
Convert Simulation Results to abc's Parameter Formatcreate_abc_param
Convert Simulation Results to abc's Summary Statistic Formatcreate_abc_sumstat
Segregating Sitescreate_locus_trio create_segsites get_positions get_snps get_trio_locus is_segsites segsites set_positions set_trio_locus
Feature: Exponential population size growth/declinefeat_growth
Feature: Ignore Singletonsfeat_ignore_singletons
Feature: Migration/Gene Flowfeat_migration
Feature: Mutationfeat_mutation
Feature: Outgroupfeat_outgroup
Feature: Population Mergefeat_pop_merge
Feature: Recombinationfeat_recombination
Feature: Selectionfeat_selection
Feature: Instantaneous Size Changefeat_size_change
Feature: Unphased Sequencesfeat_unphased
Returns the available simulatorslist_simulators
Lociloci locus locus_averaged locus_single
Locus Trioslocus_trio
Variable Parameterspar_variation
Zero Inflation for Parameterspar_zero_inflation
Model Parametersparameter par_const par_expr par_named par_prior par_range
Function that downscales a coalescent modelscale_model
Simulate Data According to a Demographic Modelsimulate.coalmodel
Simulator: msactivate_ms simulator_ms
Simulator: msmsactivate_msms simulator_msms
Simulator: scrmactivate_scrm simulator_scrm
Simulator: seq-genactivate_seqgen simulator_seqgen
Summary Statistic: DNAsumstat_dna
Summary Statistic: Filessumstat_file
Summary Statistic: Four-Gamete-Conditionsumstat_four_gamete
Summary Statistic: Integrated Extended Haplotype Homozygositysumstat_ihh
Summary Statistic: Joint Site Frequency Spectrumsumstat_jsfs
Summary Statistic: Most Common Mutation's Frequencysumstat_mcmf
Summary Statistic: Nucleotide Diversitysumstat_nucleotide_div
Summary Statistic: Omegasumstat_omega
Summary Statistic: Segregating Sitessumstat_seg_sites
Summary Statistic: Site Frequency Spectrumsumstat_sfs
Summary Statistic: Tajima's Dsumstat_tajimas_d
Summary Statistic: Ancestral Treessumstat_trees