codeml: codeml.xml comparison

comparison codeml.xml @ 1:ba71e26d5bdc draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/codeml commit 43935edeb0abb95b08b191b379e160ec25cb33c0

author	iuc
date	Wed, 02 May 2018 05:44:08 -0400
parents	961a712f9743
children	66228e9c29d9

comparison

equal deleted inserted replaced

-:961a712f9743
+:ba71e26d5bdc
 </requirements>
 <version_command><![CDATA[ codeml /dev/null 2>&1 | tail -1 ]]></version_command>
 <command><![CDATA[
 codeml '$codeml_ctl'
 &&
 mv '$codeml_ctl' '$ctl'
 ]]></command>
 <configfiles>
 <configfile name="codeml_ctl"><![CDATA[
 seqfile = $concat_nuc * sequence data file name
 RateAncestor = $adv.RateAncestor  * (0,1,2): rates (alpha>0) or ancestral states (1 or 2)
 Small_Diff = $adv.Small_Diff
 cleandata = $adv.cleandata  * remove sites with ambiguity data (1:yes, 0:no)?
 fix_blength = $adv.fix_blength   * 0: ignore, -1: random, 1: initial, 2: fixed
 method = $adv.method   * 0: simultaneous; 1: one branch at a time
 ]]></configfile>
 </configfiles>
 <inputs>
 <param name="concat_nuc" type="data" format="fasta" label="Sequences file" help="The fasta file with the sequences to be analyzed" />
 <param name="tree" type="data" format="nhx" label="tree file" help="Tree file in Newick format" />
 <conditional name="compat_model" >
 <param argument="brmodel" type="select" label="Branch model ; for tree file editing in model 2 and 3, see paml manual (chap.3)" >
 <output name="ctl" value="3_codeml.ctl" lines_diff="4" />
 </test>
 </tests>
 <help><![CDATA[
 .. class:: infomark
 **Galaxy integration** Victor Mataigne and ABIMS TEAM.
 Contact support.abims@sb-roscoff.fr for any questions or concerns about the Galaxy implementation of this tool.
 ----------
 **CompCodeML (from paml package)**
-A few help is detailed below ; full and detailed codeml readme can be found on the paml website_
+A few help is detailed below ; full and detailed codeml readme can be found on the paml website_.
 .. _website: http://abacus.gene.ucl.ac.uk/software/paml.html
 .. class:: warningmark
 Due to their high number, some parameters incompatibility can remain.
 This Galaxy implementation :
 - handles incompatibilities between branch and sites models (the tool CANNOT be run with incompatible models).
 - warns the user in a help section when an advanced parameter has known incompatibilities (the tool CAN be run, but the output files will be empty).
 We recommand to have a look at the full paml manual before looking at the advanced parameters, in order to spot parameters incompatibilities and to know what each model does. If you choose by mistake incompatible parameters, the output files will be empty, except the log file ("run_codeml" output) which will normally explicit the error.
 .. class:: infomark
 Known incompatibilities:
-- 'seqtype' = 3 : only compatible with 'FSsites' = 0.
-- 'clock' = 2 : needs branch labels in the tree.
+- 'seqtype' = 3 : only compatible with 'FSsites' = 0.
-- fix_alpha !=1 combined with alpha !=0 are not compatible with NSsites !=0
+- 'clock' = 2 : needs branch labels in the tree.
-- 'aaDist' = 0 is the only one compatible with 'NSsites' different than 0 and 'seqtype' = 1.
+- fix_alpha !=1 combined with alpha !=0 are not compatible with NSsites !=0
-- 'method' = 1 : does not work with 'clock' different than 0.
+- 'aaDist' = 0 is the only one compatible with 'NSsites' different than 0 and 'seqtype' = 1.
+- 'method' = 1 : does not work with 'clock' different than 0.
 ----------
 **Description**
 ----------
 **Parameters**
 Several models are available.
 - branch models ("model" parameter).
 - sites models ("NSsites" parameter, model is left at 0).
 - branch-sites models (when model = 2 NSsites=2,3).
 - Clade models (when model=3 NSsites=2,3).
 Basically, this tool write a configfile called codeml.ctl with the specified parameters and then launches codeml.
 .. class:: infomark
 Branch models allow the omega ratio to vary among branches in the phylogeny and are useful for detecting positive selection acting on particular lineages. Sites models allow the omega ratio to vary among sites (codons or amino acids).
 **Other examples of model**
 How to run the branch-site models (A &amp; B in Yang &amp; Nielsen 2002 MBE) ?
 The options are :
-Model A: (model=2, NSsites=2).
-Model B: (model=2, NSsites=3).
+- Model A: (model=2, NSsites=2).
+- Model B: (model=2, NSsites=3).
 How to run the M0 (one-ratio) model :
 model = 0, NSsites= = 0.
 ----------
 **Advanced Parameters**
 .. class:: infomark
-See paml complete manual and FAQ on paml website_
+See paml complete manual and FAQ on the paml website_.
 .. _website: http://abacus.gene.ucl.ac.uk/software/paml.html
 **Details of some parameters :**
 - 'kappa' denotes the transition/transversion rate ratio.
 - 'fix_kappa' specifies whether kappa in K80, F84, or HKY85 is given at a fixed value or is to be estimated by iteration from the data.
--> If fix_kappa = 1 (fixed), the value of kappa is the given value
--> If fix_kappa = 0 (estimated) the value of kappa is used as the initial estimate for iteration.
+-> If fix_kappa = 1 (fixed), the value of kappa is the given value
-- 'alpha' refers to the shape parameter alpha of the gamma distribution for variable substitution rates across sites (Yang 1994a).
+-> If fix_kappa = 0 (estimated) the value of kappa is used as the initial estimate for iteration.
-- 'fix_alpha' works in a similar way that fix_kappa.
--> The model of a single rate for all sites is specified as fix_alpha = 1 and alpha = 0 (0 means infinity)
+- 'alpha' refers to the shape parameter alpha of the gamma distribution for variable substitution rates across sites (Yang 1994a).
--> The (discrete-) gamma model is specified by a positive value for alpha, and 'ncatG' is then the number of categories for the discrete-gamma model. Values such as 5, 4, 8, or 10 are reasonable.
+- 'fix_alpha' works in a similar way that fix_kappa.
-- fix_rho and rho work in a similar way and concern independence or correlation of rates at adjacent sites, where rho is the correlation parameter of the auto-discrete-gamma model (Yang 1995).
+-> The model of a single rate for all sites is specified as fix_alpha = 1 and alpha = 0 (0 means infinity)
--> The model of independent rates for sites is specified as fix_rho = 1 and rho = 0; choosing alpha = 0 further means a constant rate for all sites.
--> The auto-discrete-gamma model is specified by positive values for both alpha and rho.
+-> The (discrete-) gamma model is specified by a positive value for alpha, and 'ncatG' is then the number of categories for the discrete-gamma model. Values such as 5, 4, 8, or 10 are reasonable.
--> The model of a constant rate for sites is a special case of the (discrete) gamma model with alpha = 0 (means infinity).
--> The model of independent rates for sites is a special case of the auto-discrete-gamma model with rho = 0.
+- fix_rho and rho work in a similar way and concern independence or correlation of rates at adjacent sites, where rho is the correlation parameter of the auto-discrete-gamma model (Yang 1995).
+-> The model of independent rates for sites is specified as fix_rho = 1 and rho = 0; choosing alpha = 0 further means a constant rate for all sites.
+-> The auto-discrete-gamma model is specified by positive values for both alpha and rho.
+-> The model of a constant rate for sites is a special case of the (discrete) gamma model with alpha = 0 (means infinity).
+-> The model of independent rates for sites is a special case of the auto-discrete-gamma model with rho = 0.
 ----------
 **Output files**
 **How to edit manually the tree file : Branch or node labels**
 Some models implemented in codeml allow several groups of branches on the tree, which are assigned different parameters of interest.
 - For example, in the local clock models (clock = 2 or 3), you can have, say, 3 branch rate groups, with low, medium, and high rates respectively.
+- Also the branch-specific codon models (model = 2 or 3 or codonml) allow different branch groups to have different ωs, leading to so called “two-ratios” and “three-ratios” models.
-- Also the branch-specific codon models (model = 2 or 3 or codonml) allow different branch groups to have different ωs, leading to so called “two-ratios” and “three-ratios” models.
+- All those models require branches or nodes in the tree to be labeled. Branch labels are specified in the same way as branch lengths except that the symbol “#” is used rather than “:”. The branch labels are consecutive integers starting from 0, which is the default and does not have to be specified.
-- All those models require branches or nodes in the tree to be labeled. Branch labels are specified in the same way as branch lengths except that the symbol “#” is used rather than “:”. The branch labels are consecutive integers starting from 0, which is the default and does not have to be specified.
 In ((Hsa_Human, Hla_gibbon) #1, ((Cgu/Can_colobus, Pne_langur), Mmu_rhesus), (Ssc_squirrelM, Cja_marmoset)); :
 The internal branch ancestral to human and gibbon has the ratio ω1, while all other branches (with the default label #0) have the background ratio ω0.
-The following trees are equivalent :
+The following trees are equivalent:
-((rabbit, rat) $1, human), goat_cow, marsupial);
+- ((rabbit, rat) $1, human), goat_cow, marsupial);
-(((rabbit #1, rat #1) #1, human), goat_cow, marsupial);
+- (((rabbit #1, rat #1) #1, human), goat_cow, marsupial);
 $ is the symbol for clade labels.
 Rules concerning nested clade labels : The symbol # takes precedence over the symbol $, and clade labels close to the tips take precedence over clade labels for ancestral nodes close to the root.
 In the tree ((((rabbit, rat) $2, human #3), goat_cow) $1, marsupial); :
 $1 is first applied to the whole clade of placental mammals (except for the human lineage), and then $2 is applied to the rabbit-rat clade.
 Equivalent tree with only '#' :
 ((((rabbit #2, rat #2) #2, human #3) #1, goat_cow #1) #1, marsupial);
 ]]></help>
 <citations>
 <citation type="doi">10.1093/molbev/msm088</citation>
 </citations>

Mercurial > repos > iuc > codeml

comparison codeml.xml @ 1:ba71e26d5bdc draft