Skip to content

Commit

Permalink
Doc/Tutorial: small addition to the PAML section
Browse files Browse the repository at this point in the history
  • Loading branch information
brandoninvergo authored and etal committed Jul 14, 2011
1 parent ab62ac5 commit e2bb900
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions Doc/Tutorial.tex
Expand Up @@ -9083,12 +9083,13 @@ \section{PAML integration}
arguments to control runtime options, usage of this wrapper strays from the format of
other application wrappers in Biopython.

A typical workflow would be to initialize a PAML object (Codeml in this example),
specifying an alignment file, a tree file, an output file and a working directory. Next,
runtime options are set via the set\_option() method or by reading an existing control
file. Finally, the program is run via the run() method and the output file is
automatically parsed to a results dictionary.
A typical workflow would be to initialize a PAML object, specifying an alignment file,
a tree file, an output file and a working directory. Next, runtime options are set via
the set\_option() method or by reading an existing control file. Finally, the program
is run via the run() method and the output file is automatically parsed to a results
dictionary.

Here is an example of typical usage of codeml:
\begin{verbatim}
>>> from Bio.Phylo.PAML import codeml
>>> cml = codeml.Codeml()
Expand All @@ -9113,10 +9114,10 @@ \section{PAML integration}
>>> print m0_params.get("omega")
\end{verbatim}

Existing output files may be also be read:

Existing output files may be parsed as well using a module's read() function:
\begin{verbatim}
>>> results = codeml.read("Tests/PAML/Results/codeml/codeml_NSsites_all.out")
>>> print results.get("lnL max")
\end{verbatim}

Documentation for this new module currently lives on the Biopython wiki:
Expand Down

0 comments on commit e2bb900

Please sign in to comment.