NcbiAligner

class NcbiAligner(force_download=None)[source]

Bases: Aligner

Aligner for NCBI xref registry.

Instantiate the aligner.

Attributes Summary

curation_header

Header to put on the curation table, corresponding to get_curation_row()

getter_kwargs

Keyword arguments to pass to the getter function on call

key

The key for the external registry

Methods Summary

get_curation_row(external_id, external_entry)

Return the relevant fields from an NCBI entry for pretty-printing.

getter()

Get the NCBI data.

Attributes Documentation

curation_header: ClassVar[Sequence[str]] = ('name', 'example', 'homepage')

Header to put on the curation table, corresponding to get_curation_row()

getter_kwargs: ClassVar[Optional[Mapping[str, Any]]] = {'force_download': False}

Keyword arguments to pass to the getter function on call

key: ClassVar[str] = 'ncbi'

The key for the external registry

Methods Documentation

get_curation_row(external_id, external_entry)[source]

Return the relevant fields from an NCBI entry for pretty-printing.

Return type:

Sequence[str]

getter()

Get the NCBI data.

Return type:

Dict[str, Dict[str, str]]