Skip to main content

ClaretBio's SRSLY Library processing software

This software is for the basic informatic processing of sequencing data generated using ClaretBio's SRSLY library prep kit with or without using UMIs.

Installation

This sofware can be installed as a python package using the command pip install srslyrun

Usage

The basic analysis can be run with srsly runsamples for standard libraries or srsly runsamples --umi for libraries with unique molecular identifiers (UMIs). This software takes in raw fastqs and trims adapters, aligns to a user-specified reference genome, and marks duplicates. For UMI aware demultiplexing of SRSLY libraries please use our SRSLYumi python package (more info at https://github.com/claretbio/SRSLYumi).

In order to run, this software requires an installation of conda- installation instructions can be found here.We recommend using mamba, which can be installed with conda install -n base -c conda-forge mamba once conda is installed. It can also be installed directly from

Required Arguments

`--reference` : a path to the reference genome you wish to align to (no default, this must be provided, and must be a file ending in `.fasta` or `.fa`)

`--libraries` or `--libfile`: the library IDs you would like analyzed in comma separated format and in a file with one id per line, respectively

Optional Arguments

`--fastqdir` : the directory containing the raw fastqs you wish to process (if not specified, defaults to current working directory)

`--resultsdir` : the directory you would like the output to be in (if not specified, defaults to current working directory)

The library IDs provided should match the beginning of the fastq files, for example the library ID for fastq files named lib1_R1.fastq.gz and lib1_R2.fastq.gz would be lib1. This can be provided directly on the command line with a comma separated list like --libraries lib1,lib2 or as a file that lists one library ID per line with --libfile libfile.txt.

an example command:

srsly runsamples --fastqdir /home/user/fastqfiles --resultsdir /home/user/srslyanalysis --reference /home/user/genomes/hg19.fa --libraries lib1,lib2,lib3

For reproducibility's sake and to ensure appropriate versions we use snakemake wrappers for many of the tools in this pipeline, which are often slow to create the first time they are used. As a result, your first time running the software may take a long time - don't worry, this is totally normal!

Release files for srslyrun 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for srslyrun 0.2.1
File Size Uploaded
srslyrun-0.2.1.tar.gz 13.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for srslyrun 0.2.1
File Interpreter ABI Platform
srslyrun-0.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 25.3 kB

Release files / srslyrun-0.2.1.tar.gz

Download URL srslyrun-0.2.1.tar.gz
Size 13.4 kB
Tags Source
SHA-256 checksum
How to use checksums
34ce1533ebaaf67abbf409173d76809effb6a82df9809d2d1231c05d288fa2bb
BLAKE2b-256 checksum
How to use checksums
dd8529f758e43aff470bcb373f2726136affee97f7733fad086a358787a0eeef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.12

Release files / srslyrun-0.2.1-py3-none-any.whl

Download URL srslyrun-0.2.1-py3-none-any.whl
Size 11.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3bd24f32c198fb956db602a71aae1024128b6676453b7118c42a3e4ca641f675
BLAKE2b-256 checksum
How to use checksums
4c43f5e7487e154329f93c0a939293c51edb0b51dfe735df99a067c71bd70c20
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.12

Release history Release notifications | RSS feed

This release

0.2.1 This release

2 release files

0.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page