Package Bio :: Package Phylo :: Package PAML :: Module baseml :: Class Baseml
[hide private]
[frames] | no frames]

Class Baseml

source code

object --+    
         |    
_paml.Paml --+
             |
            Baseml

This class implements an interface to BASEML, part of the PAML package.
Instance Methods [hide private]
 
__init__(self, alignment=None, tree=None, working_dir=None, out_file=None)
Initialize the Baseml instance.
source code
 
write_ctl_file(self)
Dynamically build a BASEML control file from the options.
source code
 
read_ctl_file(self, ctl_file)
Parse a control file and load the options into the Baseml instance.
source code
 
_set_rel_paths(self)
Convert all file/directory locations to paths relative to the current working directory.
source code
 
run(self, ctl_file=None, verbose=False, command='baseml', parse=True)
Run baseml using the current configuration and then parse the results.
source code

Inherited from _paml.Paml: get_all_options, get_option, print_options, set_options

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, alignment=None, tree=None, working_dir=None, out_file=None)
(Constructor)

source code 

Initialize the Baseml instance.

The user may optionally pass in strings specifying the locations of the input alignment and tree files, the working directory and the final output file.

Overrides: object.__init__

write_ctl_file(self)

source code 

Dynamically build a BASEML control file from the options.

The control file is written to the location specified by the ctl_file property of the baseml class.

Overrides: _paml.Paml.write_ctl_file

read_ctl_file(self, ctl_file)

source code 
Parse a control file and load the options into the Baseml instance.
Overrides: _paml.Paml.read_ctl_file

_set_rel_paths(self)

source code 

Convert all file/directory locations to paths relative to the current working directory.

BASEML requires that all paths specified in the control file be relative to the directory from which it is called rather than absolute paths.

Overrides: _paml.Paml._set_rel_paths

run(self, ctl_file=None, verbose=False, command='baseml', parse=True)

source code 

Run baseml using the current configuration and then parse the results.

Return a process signal so the user can determine if the execution was successful (return code 0 is successful, -N indicates a failure). The arguments may be passed as either absolute or relative paths, despite the fact that BASEML requires relative paths.

Overrides: _paml.Paml.run