Skip to content

Commit 3689384

Browse files
committed
Small changes
1 parent 02616bb commit 3689384

File tree

4 files changed

+2029
-9
lines changed

4 files changed

+2029
-9
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The ST Pipeline has been optimized for speed, robustness and it is very easy to
1414
The following files/parameters are required :
1515
- FASTQ files (Read 1 containing the spatial information and the UMI and read 2 containing the genomic sequence)
1616
- A genome index generated with STAR
17-
- An annotation file in GTF or GFF format
17+
- An annotation file in GTF or GFF3 format
1818
- The file containing the barcodes and array coordinates (look at the folder "ids" and chose the correct one). Basically this file contains 3 columns (BARCODE, X and Y), so if you provide this file with barcodes identinfying cells (for example), the ST pipeline can be used for single cell data.
1919
- A name for the dataset
2020

@@ -122,9 +122,11 @@ The ST pipeline is open source under the MIT license which means that you can us
122122

123123
**Reference**
124124

125-
If you use the ST Pipeline, please refer to it by including this:
125+
If you use the ST Pipeline, please refer its publication:
126126

127-
TODO: add reference
127+
ST Pipeline: An automated pipeline for spatial mapping of unique transcripts
128+
Oxford BioInformatics
129+
10.1093/bioinformatics/btx211
128130

129131
**Contact**
130132

setup.py

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
#!/usr/bin/python
22
"""
3-
ST Pipeline is a tool to process the Spatial Transcriptomics raw data.
3+
ST Pipeline is a tool to process Spatial Transcriptomics raw data (or
4+
any type of single cell data whose raw data has the same configuraiton).
45
The data is filtered, aligned to a genome, annotated to a reference,
56
demultiplexed by array coordinates and then aggregated by counts
6-
that are not duplicates using the Unique Molecular Indentifiers.
7-
The output contains the counts table, a stats file, a log file
7+
that are not duplicates using the Unique Molecular Indentifiers (UMIs).
8+
The output contains a counts table, a stats file, a log file
89
and a BED file with all the transcripts.
910
"""
1011

@@ -14,7 +15,10 @@
1415
import sys
1516
from setuptools import setup, find_packages
1617
from stpipeline.version import version_number
17-
from Cython.Build import cythonize
18+
try:
19+
from Cython.Build import cythonize
20+
except ImportError:
21+
raise SystemExit("ST Pipeline requires Cython")
1822

1923
# Get the long description from the relevant file
2024
here = os.path.abspath(os.path.dirname(__file__))
@@ -27,7 +31,6 @@
2731
except IOError:
2832
install_requires = []
2933

30-
3134
major, minor1, minor2, s, tmp = sys.version_info
3235
if major != 2 or minor1 < 7:
3336
raise SystemExit("ST Pipeline requires Python 2.7.x")

0 commit comments

Comments
 (0)