iggytop.adapters.neotcr_adapter.NEOTCRAdapter#

class iggytop.adapters.neotcr_adapter.NEOTCRAdapter(bc, cache_dir=None, receptors_to_include=('TCR', 'BCR'), test=False)#

BioCypher adapter for the NeoTCR dataset.

__init__(bc, cache_dir=None, receptors_to_include=('TCR', 'BCR'), test=False)#

Initializes the BaseAdapter instance.

Parameters:

bc (BioCypher) – An instance of the BioCypher class.
cache_dir (str | None) – Directory to cache data. Defaults to None.
receptors_to_include (Optional[Sequence[Literal['TCR', 'BCR']]]) – Receptors to include. Defaults to (“TCR”, “BCR”).
test (bool) – Whether to run in test mode. Defaults to False.

Methods

`__init__`(bc[, cache_dir, ...])	Initializes the BaseAdapter instance.
`create_anndata`()	Creates an Anndata object from the AIRR cell data and saves it to a file in the cache directory.
`get_edges`()	Yield BioCypher edges generated via OntoWeaver.
`get_latest_release`(bc)	Retrieves the latest release of the NeoTCR database.
`get_nodes`()	Yield BioCypher nodes generated via OntoWeaver.
`read_table`(bc, table_path, receptors[, test])	Reads and processes the NeoTCR table from the downloaded database file.
`set_metadata`([version, source_url, ...])	Sets the metadata for the adapter.

Attributes

`DB_DIR`	Directory name for the downloaded database.
`DB_NAME`	Name of the database.
`DB_VERSION`	Version of the NeoTCR database, taken from the date embedded in `RAW_URL`.
`FILE_NAME`	File name of the NeoTCR database.
`RAW_URL`	URL to download the NeoTCR database.
`airr_cells`	Property to get the list of AIRR cells.
`available_receptors`	Receptor types available in NeoTCR.
`cache_dir`	Property to get the cache directory.
`db_name`	Property to get the database name.
`metadata`	Property to get the adapter metadata.
`receptors`	Property to get the available receptor types.
`table`	Property to get the data table.

get_latest_release(bc)#

Retrieves the latest release of the NeoTCR database.

read_table(bc, table_path, receptors, test=False)#

Reads and processes the NeoTCR table from the downloaded database file.

Parameters:

bc (BioCypher) – An instance of the BioCypher class.
table_path (str) – Path to the table file.
receptors (list[str]) – List of receptor types to include in the table (Ignored as only TCR is available).
test (bool) – If True, loads only a subset of the data for testing (default is False).

Return type:

DataFrame

Returns:

A DataFrame containing the processed table data.

Raises:

FileNotFoundError – If the table file cannot be found.

DB_VERSION = '2022-12-20'#: Version of the NeoTCR database, taken from the date embedded in RAW_URL.

RAW_URL = 'https://github.com/lyotvincent/NeoTCR/raw/main/data/NeoTCR%20data-20221220.xlsx'#: URL to download the NeoTCR database.

available_receptors: list[str] = ['TCR']#: Receptor types available in NeoTCR.

iggytop.adapters.neotcr_adapter.NEOTCRAdapter