Skip to main content

Brain Antibody Sequence Evaluation (BASE)

Project description

Overview

This project is the adaptation of BASE from the CodeOcean capsule. See the original paper for more information.

Installation

To install BASE_dzne, you can use pip. Open your terminal and run:

pip install BASE_dzne

License

The license can be found in the LICENSE file.

Original README.md

This is the original README as found in the original capsule (see the original paper).

# Brain Antibody Sequence Evaluation (BASE): an easy-to-use software for complete data analysis in single cell immunoglobulin cloning

In this capsule, we provide the validation dataset of BASE functionality as described in (Reincke et al. 2019). To interactively use the functionality of BASE, please launch a CloudWorkstation. Additionally, we provide all the raw sequencing data corresponding to (Kreye et al. 2021).

# Background information about BASE
Repertoire analysis of patient-derived recombinant monoclonal antibodies is an important tool to study the role of B cells in autoimmune diseases of the human brain and beyond. Current protocols for generation of patient-derived recombinant monoclonal antibody libraries are time-consuming and contain repetitive steps, some of which can be assisted with the help of software automation. We developed BASE, an easy-to-use software for complete data analysis in single cell immunoglobulin cloning. BASE consists of two modules: aBASE for immunological annotations and cloning primer lookup, and cBASE for plasmid sequence identity confirmation before expression.

BASE offers an easy-to-use software solution suitable for complete Ig sequence data analysis and tracking during recombinant mcAB cloning from single cells. Plasmid sequence identity confirmation by cBASE offers functionality not provided by existing software solutions in the field and will help to reduce time-consuming steps of the monoclonal antibody generation workflow.

# Data generated in this capsule
In the capsule, the aBASE and cBASE validation datasets are generated from the sequence files in /data/SeqData. This dataset includes all monoclonal antibody chains of unknown specificity from a CSF cell sample processed using mcAB repertoire cloning in our laboratory (sample ID #AI ENC 113, Kreye et al. in preparation).
1. aBASE validation: This capsule runs aBASE on the input file aBASE-113-input.xlsx. aBASE automatically generates immunological annotations and cloning primer lookups and saves the output to /results/aBASE-output.xlsm. To validatate aBASE, we compared the automatic analysis with our own previous manual analysis (Reincke et al. 2019).
2. cBASE validation: This capsule runs cBASE on the input file cBASE-113-input.xlsx. cBASE aligns and compares the plasmid Ig sequence with the amplified cDNA-derived Ig sequence by displaying nucleotide differences and saves the output to /results/cBASE-output.xlsx. In this file, we included our previous manual analysis in column D as well as our interpretation of the differences in column G.

# Update 2021-09-05
Five additional antibody sequences have been deposited in the capsule after publication of the corresponding manuscript "Encephalitis patient derived monoclonal GABAA receptor antibodies cause epileptic seizures" (Kreye et al. 2021).


# References and Links

S. Momsen Reincke,  Harald Prüss,  Jakob Kreye. "Brain Antibody Sequence Evaluation (BASE): an easy-to-use software for complete data analysis in single cell immunoglobulin cloning". bioRxiv. doi: https://doi.org/10.1101/836999.

J. Kreye et al., "Encephalitis patient derived monoclonal GABAA receptor antibodies cause epileptic seizures". Journal of Experimental Medicine. doi: https://doi.org/10.1084/jem.20210012.

For more information, updates of the software, and instructions for standalone installations, see: https://github.com/automatedSequencing/BASE.

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

base_dzne-0.0.7.tar.gz (47.9 MB view details)

Uploaded Source

Built Distribution

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

BASE_dzne-0.0.7-py3-none-any.whl (47.9 MB view details)

Uploaded Python 3

File details

Details for the file base_dzne-0.0.7.tar.gz.

File metadata

  • Download URL: base_dzne-0.0.7.tar.gz
  • Upload date:
  • Size: 47.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for base_dzne-0.0.7.tar.gz
Algorithm Hash digest
SHA256 c34fb8ddcd2717f2129c24266dd16229fc7aced7ecf93207e86f4885c007935b
MD5 6896cb32b3e424f0f8d362f506dfb1a6
BLAKE2b-256 b123c2422ccbacd908b6a80d18b70db50b32ccb9543a84ebabae1ece6a5c4408

See more details on using hashes here.

File details

Details for the file BASE_dzne-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: BASE_dzne-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 47.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for BASE_dzne-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 c9cf1d8ccdd8ee63922a0dc048323ae3aae8185a50c450cb02016cf949e137ca
MD5 d59b336bb1e43b365258f42537d999e3
BLAKE2b-256 ded0799d053d9bedcfb53fb6b649ddab174ee47eeedd546d0c95ef44848e8026

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