Skip to main content

Python package to parse Observed antibody sequence data for easy reporting, visualization, annotation and alignment.

Project description

OAS_wrapper

A wrapper to parse Observed Antibody Space (OAS) data for better visualization, annotation and comparison of sequence to germline.

Functionalities

The scripts include functionalities to:

  1. Provide basic metrics and visualizations of sequences and their annotations
  2. Provide original IMGT sequences for V, D and J calls made in OAS data using IMGT reference database
  3. Align sequence and germline to highlight regions of mismatches, providing positional information e.g.,
Example Output:  
Sequence: ATGCCGT  
Germline: ATGTCGT  
Aligned and Highlighted Differences:  
ATGC[RED]C[/RED]GT  
ATG[RED]T[/RED]CGT  
Indices of Differences: [3]  
Mapped Regions: [(3, 'CDR2')]  
--------------------------------------------------
  1. Group data by germline, to infer sequences that originate from germline, including providing information on V, D and J annotations
Example Output:
germline,number_of_sequences,sequence,v_call,d_call,j_call,quality,source
IGHV1-69,3,ATGC,IGHV1,IGHD2,IGHJ4,High,Lab1
IGHV1-69,3,GCTA,IGHV1,IGHD2,IGHJ4,Medium,Lab2
IGHV1-69,3,ATGC,IGHV1,IGHD2,IGHJ4,High,Lab1
IGHV3-23,2,TAGC,IGHV3,IGHD3,IGHJ5,Low,Lab3
IGHV3-23,2,GCAT,IGHV3,IGHD3,IGHJ5,Medium,Lab2
  1. Annotate sequence with CDRs and FWRs for easy inference of regions of interest
Example Output:  
Original Sequence: ATGCCGTAACTG  
Annotated Sequence: A(Unannotated)T(CDR1)GC(FWR1)GT(CDR2)AA(FWR2)CT(CDR3)G(Unannotated)  
--------------------------------------------------  
Row 2:  
Original Sequence: GATTACAGTGCTA  
Annotated Sequence: GAT(CDR1)TAC(FWR1)AG(CDR2)TG(FWR2)CTA(CDR3)  
--------------------------------------------------  

Project Organization

├── LICENSE            <- Open-source license if one is chosen
├── README.md          <- The top-level README for developers using this project.
├── data 
├── notebooks          <- Jupyter notebooks. Naming convention is a number (for ordering),
└── src                <- Source code for use in this project.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oas_wrapper-1.0.tar.gz (9.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

OAS_wrapper-1.0-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file oas_wrapper-1.0.tar.gz.

File metadata

  • Download URL: oas_wrapper-1.0.tar.gz
  • Upload date:
  • Size: 9.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for oas_wrapper-1.0.tar.gz
Algorithm Hash digest
SHA256 423d64a3af807505b5defd1247e6dcb642dbe57fd219b871fe86e1116aa37c28
MD5 f90939ccf0ffd456025cf9d3451b9aeb
BLAKE2b-256 9d42129f6fdc8c8eb7da8b3a349516f4a5991a1f050aec3a15fe527ea325774d

See more details on using hashes here.

File details

Details for the file OAS_wrapper-1.0-py3-none-any.whl.

File metadata

  • Download URL: OAS_wrapper-1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for OAS_wrapper-1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eab19e4c4d8fecd58b3dc8477a99c7785726439c2a00c0f233d38ca547aaf897
MD5 1cd3423b0d6623f3912406cae17791c4
BLAKE2b-256 0e55603d9ca515d0db838297c8a65e50311f05d190447fc6b1575d4690cf0310

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page