Warning

This document is for an in-development version of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

galaxy.tools.util package

Utilities used by various Galaxy tools

FIXME: These are used by tool scripts, not the framework, and should not live
in this package.

Submodules

galaxy.tools.util.maf_utilities module

Provides wrappers and utilities for working with MAF files and alignments.

galaxy.tools.util.maf_utilities.maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

galaxy.tools.util.maf_utilities.src_split(src)[source]
galaxy.tools.util.maf_utilities.src_merge(spec, chrom, contig=None)[source]
galaxy.tools.util.maf_utilities.get_species_in_block(block)[source]
galaxy.tools.util.maf_utilities.tool_fail(msg='Unknown Error')[source]
class galaxy.tools.util.maf_utilities.TempFileHandler(max_open_files=None, **kwds)[source]

Bases: object

Handles creating, opening, closing, and deleting of Temp files, with a maximum number of files open at one time.

DEFAULT_MAX_OPEN_FILES = 524288.0
__init__(max_open_files=None, **kwds)[source]

Initialize self. See help(type(self)) for accurate signature.

get_open_tempfile(index=None, **kwds)[source]
close(index, delete=False)[source]
flush(index)[source]
class galaxy.tools.util.maf_utilities.RegionAlignment(size, species=[], temp_file_handler=None)[source]

Bases: object

DNA_COMPLEMENT = {65: 84, 67: 71, 71: 67, 84: 65, 97: 116, 99: 103, 103: 99, 116: 97}
MAX_SEQUENCE_SIZE = 9223372036854775807
__init__(size, species=[], temp_file_handler=None)[source]

Initialize self. See help(type(self)) for accurate signature.

add_species(species)[source]
get_species_names(skip=[])[source]
get_sequence(species)[source]
get_sequence_reverse_complement(species)[source]
set_position(index, species, base)[source]
set_range(index, species, bases)[source]
flush(species=None)[source]
class galaxy.tools.util.maf_utilities.GenomicRegionAlignment(start, end, species=[], temp_file_handler=None)[source]

Bases: galaxy.tools.util.maf_utilities.RegionAlignment

__init__(start, end, species=[], temp_file_handler=None)[source]

Initialize self. See help(type(self)) for accurate signature.

class galaxy.tools.util.maf_utilities.SplicedAlignment(exon_starts, exon_ends, species=[], temp_file_handler=None)[source]

Bases: object

DNA_COMPLEMENT = {65: 84, 67: 71, 71: 67, 84: 65, 97: 116, 99: 103, 103: 99, 116: 97}
__init__(exon_starts, exon_ends, species=[], temp_file_handler=None)[source]

Initialize self. See help(type(self)) for accurate signature.

get_species_names(skip=[])[source]
get_sequence(species)[source]
get_sequence_reverse_complement(species)[source]
start
end
galaxy.tools.util.maf_utilities.maf_index_by_uid(maf_uid, index_location_file)[source]
galaxy.tools.util.maf_utilities.open_or_build_maf_index(maf_file, index_filename, species=None)[source]
galaxy.tools.util.maf_utilities.build_maf_index_species_chromosomes(filename, index_species=None)[source]
galaxy.tools.util.maf_utilities.build_maf_index(maf_file, species=None)[source]
galaxy.tools.util.maf_utilities.component_overlaps_region(c, region)[source]
galaxy.tools.util.maf_utilities.chop_block_by_region(block, src, region, species=None, mincols=0)[source]
galaxy.tools.util.maf_utilities.orient_block_by_region(block, src, region, force_strand=None)[source]
galaxy.tools.util.maf_utilities.get_oriented_chopped_blocks_for_region(index, src, region, species=None, mincols=0, force_strand=None)[source]
galaxy.tools.util.maf_utilities.get_oriented_chopped_blocks_with_index_offset_for_region(index, src, region, species=None, mincols=0, force_strand=None)[source]
galaxy.tools.util.maf_utilities.iter_blocks_split_by_src(block, src)[source]
galaxy.tools.util.maf_utilities.iter_blocks_split_by_species(block, species=None)[source]
galaxy.tools.util.maf_utilities.get_chopped_blocks_for_region(index, src, region, species=None, mincols=0)[source]
galaxy.tools.util.maf_utilities.get_chopped_blocks_with_index_offset_for_region(index, src, region, species=None, mincols=0)[source]
galaxy.tools.util.maf_utilities.get_region_alignment(index, primary_species, chrom, start, end, strand='+', species=None, mincols=0, overwrite_with_gaps=True, temp_file_handler=None)[source]
galaxy.tools.util.maf_utilities.reduce_block_by_primary_genome(block, species, chromosome, region_start)[source]
galaxy.tools.util.maf_utilities.fill_region_alignment(alignment, index, primary_species, chrom, start, end, strand='+', species=None, mincols=0, overwrite_with_gaps=True)[source]
galaxy.tools.util.maf_utilities.get_spliced_region_alignment(index, primary_species, chrom, starts, ends, strand='+', species=None, mincols=0, overwrite_with_gaps=True, temp_file_handler=None)[source]
galaxy.tools.util.maf_utilities.line_enumerator(lines, comment_start='#')[source]
galaxy.tools.util.maf_utilities.get_starts_ends_fields_from_gene_bed(line)[source]
galaxy.tools.util.maf_utilities.iter_components_by_src(block, src)[source]
galaxy.tools.util.maf_utilities.get_components_by_src(block, src)[source]
galaxy.tools.util.maf_utilities.iter_components_by_src_start(block, src)[source]
galaxy.tools.util.maf_utilities.get_components_by_src_start(block, src)[source]
galaxy.tools.util.maf_utilities.sort_block_components_by_block(block1, block2)[source]
galaxy.tools.util.maf_utilities.get_species_in_maf(maf_filename)[source]
galaxy.tools.util.maf_utilities.parse_species_option(species)[source]
galaxy.tools.util.maf_utilities.remove_temp_index_file(index_filename)[source]
galaxy.tools.util.maf_utilities.get_fasta_header(component, attributes={}, suffix=None)[source]
galaxy.tools.util.maf_utilities.get_attributes_from_fasta_header(header)[source]
galaxy.tools.util.maf_utilities.iter_fasta_alignment(filename)[source]