EIYBrowse.filetypes package

Submodules

• EIYBrowse.filetypes.gffutils_db module
• EIYBrowse.filetypes.interactions_db module
• EIYBrowse.filetypes.my5c_folder module

Module contents

This module provides some helper functions for opening the correct file handler given a string representation of the file type to open.

Available filetypes are found through setuptools automatic plugin discovery feature.

EIYBrowse defines available filetype plugins under the EIYBrowse.filetypes entry point. This module also adds gffutils FeatureDB class, and the file classes defined by the metaseq package, if they are available.

To define a new filetype which can be used by EIYBrowse, any package just needs to define it in the entry_points section of the package’s setup.py. For example:

setup(
    name = "EIYBrowse_ChIA_PET_plugin",
    packages=['chiapet_plugin'],
    entry_points = {'EIYBrowse.filetypes': [
                        'chia_pet = chiapet_plugin.plugin_module:ChiaPETPluginClass',
                    ]
                   },
)

EIYBrowse.filetypes.get_file_opener(file_type)

EIYBrowse.filetypes.open_file(file_path, file_type)