Difference between revisions of "MIGRATE-N"

From UFRC
Jump to navigation Jump to search
(Created page with "Category:SoftwareCategory:biologyCategory:bioinformaticsCategory:population genetics {|<!--CONFIGURATION: REQUIRED--> |{{#vardefine:app|migraten}} |{{#vardefin...")
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Software]][[Category:biology]][[Category:bioinformatics]][[Category:population genetics]]
+
__NOTOC__
{|<!--CONFIGURATION: REQUIRED-->
+
__NOEDITSECTION__
 +
[[Category:Software]][[Category:Genomics]][[Category:Biology]]
 +
{|<!--Main settings - REQUIRED-->
 
|{{#vardefine:app|migraten}}
 
|{{#vardefine:app|migraten}}
 
|{{#vardefine:url|http://popgen.sc.fsu.edu/Migrate/Migrate-n.html}}
 
|{{#vardefine:url|http://popgen.sc.fsu.edu/Migrate/Migrate-n.html}}
<!--CONFIGURATION: OPTIONAL (|1}} means it's ON)-->
+
|{{#vardefine:exe|1}} <!--Present manual instructions for running the software -->
|{{#vardefine:conf|}}           <!--CONFIGURATION-->
+
|{{#vardefine:conf|}} <!--Enable config wiki page link - {{#vardefine:conf|1}} = ON/conf|}} = OFF-->
|{{#vardefine:exe|}}           <!--ADDITIONAL INFO-->
+
|{{#vardefine:pbs|1}} <!--Enable PBS script wiki page link-->
|{{#vardefine:job|}}           <!--JOB SCRIPTS-->
+
|{{#vardefine:policy|}} <!--Enable policy section -->
|{{#vardefine:policy|}}         <!--POLICY-->
+
|{{#vardefine:testing|}} <!--Enable performance testing/profiling section -->
|{{#vardefine:testing|}}       <!--PROFILING-->
+
|{{#vardefine:faq|}} <!--Enable FAQ section -->
|{{#vardefine:faq|}}             <!--FAQ-->
+
|{{#vardefine:citation|}} <!--Enable Reference/Citation section -->
|{{#vardefine:citation|}}       <!--CITATION-->
 
|{{#vardefine:installation|}} <!--INSTALLATION-->
 
 
|}
 
|}
<!--BODY-->
+
<!-- ########  Template Body ######## -->
 
<!--Description-->
 
<!--Description-->
 
{{#if: {{#var: url}}|
 
{{#if: {{#var: url}}|
 
{{App_Description|app={{#var:app}}|url={{#var:url}}|name={{#var:app}}}}|}}
 
{{App_Description|app={{#var:app}}|url={{#var:url}}|name={{#var:app}}}}|}}
  
Migrate estimates effective population sizes and past migration rates between n population assuming a migration matrix model with asymmetric migration rates and different subpopulation sizes. Migrate uses maximum likelihood or Bayesian inference to jointly estimate all parameters.
+
Migrate estimates effective population sizes and past migration rates between n population assuming a migration matrix model with asymmetric migration rates and different subpopulation sizes. Migrate uses maximum likelihood or Bayesian inference to jointly estimate all parameters. It can use the following data types:
 
+
* Sequence data using Felsenstein's 84 model with or without site rate variation,
 +
* Single nucleotide polymorphism data (sequence-like data input, HAPMAP-like data input)
 +
* Microsatellite data using a stepwise mutation model or a brownian motion mutation model (using the repeatlength input format or the fragment-length input format),
 +
* Electrophoretic data using an 'infinite' allele model.
 
<!--Modules-->
 
<!--Modules-->
 
==Environment Modules==
 
==Environment Modules==
Run <code>module spider {{#var:app}}</code> to find out what environment modules are available for this application.
+
Run <code>$ module spider {{#var:app}}</code> to find out what environment modules are available for this application.
 +
 
 +
===Serial Module===
 +
For the serial binary:
 +
 
 +
<code>$ module load migraten/4.4.4</code>
 +
 
 +
===Parallel Module (MPI)===
 +
For the MPI binary:
 +
 
 +
<code>$ module load intel/2020 openmpi/4.1.1 migraten/5.0.4</code>
 +
 
 +
 
 
==System Variables==
 
==System Variables==
* HPC_{{#uppercase:{{#var:app}}}}_DIR - installation directory
+
* HPC_{{uc:{{#var:app}}}}_DIR - installation directory
* HPC_{{#uppercase:{{#var:app}}}}_BIN - executable directory
+
* HPC_MIGRATEN_BIN - executable directory
* HPC_{{#uppercase:{{#var:app}}}}_MAN - manual directory
+
* HPC_{{uc:{{#var:app}}}}_MAN - manual directory
 +
<!--Additional-->
 +
{{#if: {{#var: exe}}|==Additional Information==
 +
A manual page is available. Run '''man migrate''' to view it after loading the appropriate module.
  
<!--Configuration-->
+
Full manual is available from the [http://popgen.sc.fsu.edu/migratedoc.pdf Migrate-n website].
{{#if: {{#var: conf}}|==Configuration==
 
See the [[{{PAGENAME}}_Configuration]] page for {{#var: app}} configuration details.
 
|}}
 
<!--Run-->
 
{{#if: {{#var: exe}}|==Additional Information==
 
  
WRITE_ADDITIONAL_INSTRUCTIONS_ON_RUNNING_THE_SOFTWARE_IF_NECESSARY
+
Serial command example:
 +
<code>$ migrate-n parmfile -nomenu</code>
  
|}}
+
Parallel command example:
<!--Job Scripts-->
 
{{#if: {{#var: job}}|==Job Script Examples==
 
See the [[{{PAGENAME}}_Job_Scripts]] page for {{#var: app}} Job script examples.
 
|}}
 
<!--Policy-->
 
{{#if: {{#var: policy}}|==Usage Policy==
 
  
WRITE USAGE POLICY HERE (Licensing, usage, access).
+
<code>$ migrate-n</code>
  
|}}
+
Or
<!--Performance-->
 
{{#if: {{#var: testing}}|==Performance==
 
  
WRITE_PERFORMANCE_TESTING_RESULTS_HERE
+
<code>$ mpiexec migrate-n-mpi parmfile -nomenu</code>
  
 
|}}
 
|}}
<!--Faq-->
+
 
 +
{{#if: {{#var: conf}}|==Configuration==
 +
See the [[{{PAGENAME}}_Configuration]] page for {{#var: app}} configuration details.|}}
 +
{{#if: {{#var: policy}}|==Usage Policy==
 +
WRITE USAGE POLICY HERE (perhaps templates for a couple of main licensing schemes can be used)|}}
 +
{{#if: {{#var: testing}}|==Performance==
 +
WRITE PERFORMANCE TESTING RESULTS HERE|}}
 
{{#if: {{#var: faq}}|==FAQ==
 
{{#if: {{#var: faq}}|==FAQ==
 
*'''Q:''' **'''A:'''|}}
 
*'''Q:''' **'''A:'''|}}
<!--Citation-->
+
{{#if: {{#var: citation}}1|==Citation==
{{#if: {{#var: citation}}|==Citation==
+
If you publish research that uses migrate-n you have to cite it as follows:
If you publish research that uses {{#var:app}} you have to cite it as follows:
+
 
 +
 
 +
Maximum likelihood: Beerli 1998; Beerli and Felsenstein 1999, 2001.
 +
 
 +
Bayesian inference: Beerli 2006; Beerli and Felsenstein 2001.
 +
 
 +
Missing population issues: Beerli 2004.
 +
 
 +
General use of migrate: Beerli 2009.
 +
 
 +
Bayes factor and marginal likelihood: Beerli and Palczewski 2010.
 +
 
 +
 
 +
Beerli, P. (1998) Estimation of migration rates and population sizes in geographically structured populations. In: Advances in molecular ecology (Ed. G. Carvalho). NATO-ASI workshop series. IOS Press, Amsterdam. Pp. 39-53.
 +
 
 +
Beerli, P. and J. Felsenstein (1999) Maximum-likelihood estimation of migration rates and effective population numbers in two populations using a coalescent approach. Genetics, 152(2):763–73, 1999
 +
 
 +
Beerli, P. and J. Felsenstein (2001) Maximum likelihood estimation of a migration matrix and effective population sizes in n subpopulations by using a coalescent approach. Proceedings of the National Academy of Sciences of the USA, 98(8):4563–4568.
 +
 
 +
Beerli, P. (2004) Effect of unsampled populations on the estimation of population sizes and migration rates between sampled populations. Molecular Ecology, 13:827–836.
 +
 
 +
Beerli, P. (2006) Comparison of Bayesian and maximum likelihood inference of population genetic parameters. Bioinformatics, 22(3):341–345.
  
WRITE_CITATION_HERE
+
Beerli, P. (2009) How to use migrate or why are markov chain monte carlo programs difficult to use? In G. Bertorelle, M. W. Bruford, H. C. Hauffe, A. Rizzoli, and C. Vernesi, editors, Population Genetics for Animal Conservation, volume 17 of Conservation Biology, pages 42–79. Cambridge University Press, Cambridge UK, 2009.
  
 +
Beerli, P. and M. Palczewski (2010) Unified framework to evaluate panmixia and migration direction among multiple sampling locations. Genetics, 185:313–326
 
|}}
 
|}}
<!--Installation-->
 
{{#if: {{#var: installation}}|==Installation==
 
See the [[{{PAGENAME}}_Install]] page for {{#var: app}} installation notes.|}}
 
<!--Turn the Table of Contents and Edit paragraph links ON/OFF-->
 
__NOTOC____NOEDITSECTION__
 

Revision as of 19:44, 18 August 2022

Description

migraten website  

Migrate estimates effective population sizes and past migration rates between n population assuming a migration matrix model with asymmetric migration rates and different subpopulation sizes. Migrate uses maximum likelihood or Bayesian inference to jointly estimate all parameters. It can use the following data types:

  • Sequence data using Felsenstein's 84 model with or without site rate variation,
  • Single nucleotide polymorphism data (sequence-like data input, HAPMAP-like data input)
  • Microsatellite data using a stepwise mutation model or a brownian motion mutation model (using the repeatlength input format or the fragment-length input format),
  • Electrophoretic data using an 'infinite' allele model.

Environment Modules

Run $ module spider migraten to find out what environment modules are available for this application.

Serial Module

For the serial binary:

$ module load migraten/4.4.4

Parallel Module (MPI)

For the MPI binary:

$ module load intel/2020 openmpi/4.1.1 migraten/5.0.4


System Variables

  • HPC_MIGRATEN_DIR - installation directory
  • HPC_MIGRATEN_BIN - executable directory
  • HPC_MIGRATEN_MAN - manual directory

Additional Information

A manual page is available. Run man migrate to view it after loading the appropriate module.

Full manual is available from the Migrate-n website.

Serial command example: $ migrate-n parmfile -nomenu

Parallel command example:

$ migrate-n

Or

$ mpiexec migrate-n-mpi parmfile -nomenu



Citation

If you publish research that uses migrate-n you have to cite it as follows:


Maximum likelihood: Beerli 1998; Beerli and Felsenstein 1999, 2001.

Bayesian inference: Beerli 2006; Beerli and Felsenstein 2001.

Missing population issues: Beerli 2004.

General use of migrate: Beerli 2009.

Bayes factor and marginal likelihood: Beerli and Palczewski 2010.


Beerli, P. (1998) Estimation of migration rates and population sizes in geographically structured populations. In: Advances in molecular ecology (Ed. G. Carvalho). NATO-ASI workshop series. IOS Press, Amsterdam. Pp. 39-53.

Beerli, P. and J. Felsenstein (1999) Maximum-likelihood estimation of migration rates and effective population numbers in two populations using a coalescent approach. Genetics, 152(2):763–73, 1999

Beerli, P. and J. Felsenstein (2001) Maximum likelihood estimation of a migration matrix and effective population sizes in n subpopulations by using a coalescent approach. Proceedings of the National Academy of Sciences of the USA, 98(8):4563–4568.

Beerli, P. (2004) Effect of unsampled populations on the estimation of population sizes and migration rates between sampled populations. Molecular Ecology, 13:827–836.

Beerli, P. (2006) Comparison of Bayesian and maximum likelihood inference of population genetic parameters. Bioinformatics, 22(3):341–345.

Beerli, P. (2009) How to use migrate or why are markov chain monte carlo programs difficult to use? In G. Bertorelle, M. W. Bruford, H. C. Hauffe, A. Rizzoli, and C. Vernesi, editors, Population Genetics for Animal Conservation, volume 17 of Conservation Biology, pages 42–79. Cambridge University Press, Cambridge UK, 2009.

Beerli, P. and M. Palczewski (2010) Unified framework to evaluate panmixia and migration direction among multiple sampling locations. Genetics, 185:313–326