Skip to main content

libBASE

Project description

Overview

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

Installation

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

pip install libBASE

License

The license can be found in the LICENSE file.

Original README.md

# 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

libbase-2.0.0.dev4.tar.gz (102.4 kB view details)

Uploaded Source

Built Distribution

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

libBASE-2.0.0.dev4-py3-none-any.whl (89.1 kB view details)

Uploaded Python 3

File details

Details for the file libbase-2.0.0.dev4.tar.gz.

File metadata

  • Download URL: libbase-2.0.0.dev4.tar.gz
  • Upload date:
  • Size: 102.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for libbase-2.0.0.dev4.tar.gz
Algorithm Hash digest
SHA256 4e14d6c4a09a064bec2926d5bc80b0f631b6fc9a057ed6efdcebdcc308dec475
MD5 6fcd8b7e6045f27c1068936722300ba5
BLAKE2b-256 bc6968ff7f3154978ab5c90f5e662be8b3cfd8b5a97993feb71dd078c4bf4a6c

See more details on using hashes here.

File details

Details for the file libBASE-2.0.0.dev4-py3-none-any.whl.

File metadata

  • Download URL: libBASE-2.0.0.dev4-py3-none-any.whl
  • Upload date:
  • Size: 89.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for libBASE-2.0.0.dev4-py3-none-any.whl
Algorithm Hash digest
SHA256 67d3625bec82878761ca797487efa2d5941c57d2c69056e748f8e2d46fe8c571
MD5 2a217a9bbc0a650c9e9f08adec99d001
BLAKE2b-256 5ce0f3b37d5c936d95353e64db7aef8e3f90ddb5210120b8f732025dba6c4130

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