tidytcells.ig#

Functions to manage IG gene data.

Functions

tidytcells.ig.query(species=None, precision=None, functionality=None, contains_pattern=None)[source]#

Query the list of all known IG: genes / alleles.

Parameters:

species (str) – Species to query (see above for supported species). Defaults to "homosapiens".
precision (str) – The level of precision to query. allele will query from the set of all possible alleles. gene will query from the set of all possible genes. Defaults to allele.
functionality (str) – Gene/allele functionality to subset by. "any" queries from all possible genes/alleles. "F" queries from functional genes/alleles. "NF" queries from psuedogenes and ORFs. "P" queries from pseudogenes. "ORF" queries from ORFs. An allele is considered queriable if its functionality label matches the description. A gene is considered queriable if at least one of its alleles’ functionality label matches the description. Defaults to "any".
contains_pattern (str) – An optional regular expression string which will be used to filter the query result. If supplied, only genes/alleles which contain the regular expression will be returned. Defaults to None.

Returns:

The set of all genes / alleles that satisfy the given constraints.

Return type:

FrozenSet[str]

tidytcells.ig.standardise(*args, **kwargs)[source]#

Alias for tidytcells.ig.standardize().

Return type:: ReceptorGene

tidytcells.ig.standardize(symbol=None, species=None, enforce_functional=None, allow_subgroup=None, log_failures=None, gene=None, suppress_warnings=None)[source]#

Attempt to standardize a IG gene / allele symbol to be IMGT-compliant.

Parameters:

symbol (str) – Potentially non-standardized IG gene / allele symbol.
species (str) –
Can be specified to standardize to an IG symbol that is known to be valid for that species (see above for supported species). If set to "any", then first attempts standardization for Homo sapiens, then Mus musculus. Defaults to "homosapiens".

Note

From version 3, the default behaviour will change to "any".
enforce_functional (bool) – If True, disallows IG genes / alleles that are recognised by IMGT but are marked as non-functional (ORF or pseudogene). Defaults to False.
allow_subgroup (bool) – If True, allows valid subgroups (as well as more specific gene/allele symbos) to pass standardization. If False, the supplied symbol must point to at least a specific gene. Defaults to False.
log_failures (bool) – Report standardization failures through logging (at level WARNING). Defaults to True.
gene (str) – Alias for the parameter symbol.
suppress_warnings (bool) – Disable warnings that are usually logged when standardization fails. Deprecated in favour of log_failures.

Returns:

A standardized receptor gene wrapped in a ReceptorGene object. For details on how to use this output, please refer to the class documentation.

Return type:

~tidytcells.result.ReceptorGene

Example usage

IG standardized results will be returned as a ReceptorGene. When standardization is a success, attributes ‘allele’, ‘gene’ and ‘subgroup’ can be used to retrieve the corrected information.

>>> result = tt.ig.standardize("IGHV1-2*01")
>>> result.is_standardized
True
>>> result.allele
'IGHV1-2*01'
>>> result.gene
'IGHV1-2'
>>> result.subgroup
'IGHV1'

Attributes ‘allele’, ‘gene’ and ‘subgroup’ only return a result if the symbol could be standardized up to that level. Attribute ‘symbol’ is never None for a successful standardization, and always returns the most detailed available result between ‘allele’, ‘gene’ and ‘subgroup’.

>>> tt.ig.standardize("IGHV1-2*01").symbol
'IGHV1-2*01'
>>> tt.ig.standardize("IGHV1-2").allele
None
>>> tt.ig.standardize("IGHV1-2").gene
'IGHV1-12'
>>> tt.ig.standardize("IGHV1-2").symbol
'IGHV1-12'

Non-standardized input strings will intelligently be corrected to IMGT-compliant gene / allele symbols.

>>> tt.ig.standardize("hj1").symbol
'IGHJ1'

The enforce_functional setting will cause non-functional genes or alleles to be rejected. For failed standardizations, the ‘error’ attribute explains why the standardization failed, and the ‘attempted_fix’ attribute contains the best attempted result found during standardization.

>>> result = tt.ig.standardize("ighV1-12", enforce_functional=True)
>>> result.is_standardized
False
>>> result.error
'Gene has no functional alleles'
>>> result.attempted_fix
'IGHV1-12'

Known synonyms are included in the standardization

>>> tt.ig.standardize("A10").symbol
'IGKV6D-21'

Mus musculus is a supported species.

>>> tt.ig.standardize("IGHV2-2", species="musmusculus").gene
'IGHV2-2'

Other available properties are ‘original_input’, ‘species’, ‘receptor_type’, ‘locus’ and ‘gene_type’.

>>> result = tt.ig.standardize("IGHV01-02")
>>> result.symbol
'IGHV1-2'
>>> result.original_input
'IGHV01-02'
>>> result.species
'homosapiens'
>>> result.receptor_type
'IG'
>>> result.locus
'IGH'
>>> result.gene_type
'V'

Utility method ‘get_all_alleles’ can be used to retrieve all (functional) alleles for a given symbol.

>>> result = tt.ig.standardize("IGHV1-3")
>>> result.get_all_alleles()
['IGHV1-3*01', 'IGHV1-3*02', 'IGHV1-3*03', 'IGHV1-3*04', 'IGHV1-3*05']

>>> result = tt.ig.standardize("IGHV1-67")
>>> result.get_all_alleles(enforce_functional=True)
[]
>>> result.get_all_alleles(enforce_functional=True)
['IGHV1-67*02', 'IGHV1-67*03', 'IGHV1-67*01']

Utility method ‘get_aa_sequences’ can be used to retrieve known amino acid sequences per allele. Using sequence_type ‘ALL’ shows all available sequence data for each allele.

>>> result = tt.ig.standardize("IGHV1-3*01")
>>> result.get_aa_sequences(sequence_type="CDR1")
{'IGHV1-3*01': 'GYTFTSYA'}
>>> result.get_aa_sequences(sequence_type="CDR2")
{'IGHV1-3*01': 'INAGNGNT'}
>>> result = tt.ig.standardize("IGLJ3")
>>> result.get_aa_sequences(sequence_type="ALL")
{
'IGLJ3*01': {
    'J-MOTIF': 'FGGG', 'J-REGION': 'VVFGGGTKLTVL', 'functionality': 'F'
    },
'IGLJ3*02': {
    'J-MOTIF': 'FGGG', 'J-REGION': 'WVFGGGTKLTVL', 'functionality': 'F'
    }
}

Decision Logic

To provide an easy way to gauge the scope and limitations of standardization, below is a simplified overview of the decision logic employed when attempting to standardize a TR symbol. For more detail, please refer to the source code.

0. sanity-check input
Skip standardization if invalid parameters are passed (invalid amino acids in sequence, invalid species, etc)

1. attempt standardization
IF symbol is already in IMGT-compliant form:
    set standardization status as successful, skip to step 2

IF symbol is a known deprecated symbol:
    overwrite symbol with current IMGT-compliant symbol
    set standardization status as successful, skip to step 2

replace "." with "-"                                        //e.g. IGHV1.2 -> IGHV1-2
add back any missing backslashes                            //e.g. IGHV1OR15-1 -> IGHV1/OR15-1
remove any unnecessary trailing zeros                       //e.g. IGHV1-02 -> IGHV1-2
IF symbol is now in IMGT-compliant form:
    set standardization status as successful, skip to step 2

add "IG" to the beginning of the symbol if necessary        //e.g. HV1-18 -> IGHV1-18
IF symbol is now in IMGT-compliant form:
    set standardization status as successful, skip to step 2

try removing "-1" from the end of the symbol                //e.g. IGHJ1-1 -> IGHJ1
IF symbol is now in IMGT-compliant form:
    set standardization status as successful, skip to step 2

set standardization status as failed

2. finalisation
IF standardization has not failed:
    consider standardization a success

RETURN :py:class:`~tidytcells.result.ReceptorGene`

tidytcells.ig

Contents

tidytcells.ig#