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.dev2.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.dev2-py3-none-any.whl (89.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: libbase-2.0.0.dev2.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.dev2.tar.gz
Algorithm Hash digest
SHA256 73927ffe0d6d5056eb3cc25cf7b56274b19c7b88c8cbd0a2d698cafb5d83b7d2
MD5 883ed49e29822fef6313dea9cc742ec3
BLAKE2b-256 1d92c67db2a4fc1f80c98f8d7e65479b7da09f39ec85a9ec25d46fc393661790

See more details on using hashes here.

File details

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

File metadata

  • Download URL: libBASE-2.0.0.dev2-py3-none-any.whl
  • Upload date:
  • Size: 89.2 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.dev2-py3-none-any.whl
Algorithm Hash digest
SHA256 ed48c0d36b5aefd2ebdb36118a8aae420c252ff61f8f8baaf857585d65e1d8e2
MD5 1afb9a7a041dc62637eedc31e557bb20
BLAKE2b-256 fd925585f3913bc2e59e5d6101b8e42cc4b2aa67892008efab08485fb25a4713

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