Skip to content

Commit

Permalink
Merge branch 'master' of ssh://github.com/minoda-lab/universc into dev
Browse files Browse the repository at this point in the history
Conflicts:
	CHANGELOG
	Dockerfile
	README.html
	README.md
	launch_universc.sh
  • Loading branch information
TomKellyGenetics committed Feb 28, 2023
2 parents dc97003 + c2d0c88 commit 35eaf68
Show file tree
Hide file tree
Showing 32 changed files with 1,685 additions and 1,743 deletions.
2 changes: 1 addition & 1 deletion .version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.2.5-dev
1.2.5.1
8 changes: 6 additions & 2 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
### 1.2.5-dev
### 1.2.5.1

- minor patch to revert potentially breaking changes in v1.2.5 when running perl instead of sed

### 1.2.5

- updates PATH environment variable to call /universc/launch_universc.sh from any working directory

Expand All @@ -9,7 +13,7 @@ BGI or Ultima high throughput sequencing platforms)
- migrates sed calls to perl for better memory-efficiency on large input files

- set default user as "root" in docker containers and ensure that cellranger is writeable
to allow running in nextflow or singularity
to allow running in nextflow or singularity (https://github.com/nf-core/modules/pull/1706)

### 1.2.4

Expand Down
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ authors:
email: "[email protected]"
affiliation: "Center for Sustainable Resource Science, RIKEN, Suehiro-cho-1-7-22, Tsurumi Ward, Yokohama, Japan"
orcid: "http://orcid.org/0000-0001-7517-2657"
version: 1.2.5-dev
version: 1.2.5.1
doi: 10.1101/2021.01.19.427209
date-released: 2021-02-14
url: "https://github.com/minoda-lab/universc"
Expand Down
5 changes: 5 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,18 @@ RUN mkdir -p /cellranger-3.0.2.9001/cellranger-tiny-ref \
&& ln -s /universc/test/cellranger_reference/cellranger-tiny-ref/1.2.0 /cellranger-3.0.2.9001/cellranger-tiny-ref \
&& ln -s /universc/test/cellranger_reference/cellranger-tiny-ref/3.0.0 /cellranger-3.0.2.9001/cellranger-tiny-ref

RUN ln -s /universc/launch_universc.sh /universc/universc
ENV PATH /universc:$PATH

COPY ./launch_universc.sh /universc/launch_universc.sh
RUN ln /universc/launch_universc.sh /cellranger-3.0.2.9001/cellranger-cs/3.0.2.9001/bin/universc
RUN ln -s /universc/sub /cellranger-3.0.2.9001/cellranger-cs/3.0.2.9001/bin/sub
RUN ln -s /universc/whitelists /cellranger-3.0.2.9001/cellranger-cs/3.0.2.9001/bin/whitelists

ENV LC_ALL C.UTF-8
ENV LANG C.UTF-8

RUN cp /cellranger-3.0.2.9001/cellranger-cs/3.0.2.9001/lib/python/cellranger/chemistry.py /cellranger-3.0.2.9001/cellranger-cs/3.0.2.9001/lib/python/cellranger/check.py

RUN chmod -R 777 /cellranger-3.0.2.9001/* /universc/*
RUN chmod a+w /cellranger-3.0.2.9001 /universc
40 changes: 21 additions & 19 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ tags:
![Docker Stars](https://img.shields.io/docker/stars/tomkellygenetics/universc)
![Docker Pulls](https://img.shields.io/docker/pulls/tomkellygenetics/universc)

![Docker Image Version (tag latest semver)](https://img.shields.io/docker/v/tomkellygenetics/universc/1.2.5-dev)
![MicroBadger Layers (latest)](https://img.shields.io/microbadger/layers/tomkellygenetics/universc/latest?label="[email protected]-dev")
![Docker Image Size (v1.2.5-dev)](https://img.shields.io/docker/image-size/tomkellygenetics/universc/1.2.5-dev?label="image%[email protected]-dev)
![Docker Image Version (tag latest semver)](https://img.shields.io/docker/v/tomkellygenetics/universc/1.2.5.1)
![MicroBadger Layers (latest)](https://img.shields.io/microbadger/layers/tomkellygenetics/universc/latest?label="[email protected].1")
![Docker Image Size (v1.2.5.1)](https://img.shields.io/docker/image-size/tomkellygenetics/universc/1.2.5.1?label="image%[email protected].1)
![Docker Image Version (latest by date)](https://img.shields.io/docker/v/tomkellygenetics/universc/latest)
![MicroBadger Layers (latest)](https://img.shields.io/microbadger/layers/tomkellygenetics/universc/latest)
![Docker Image Size (latest)](https://img.shields.io/docker/image-size/tomkellygenetics/universc/latest)
Expand All @@ -62,8 +62,8 @@ tags:

![GitHub all releases](https://img.shields.io/github/downloads/minoda-lab/universc/total?label=GitHub%20downloads)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/minoda-lab/universc?label=GitHub%20release)
![GitHub release (latest by date)](https://img.shields.io/github/downloads/minoda-lab/universc/1.2.5-dev/total)
![GitHub release (by tag)](https://img.shields.io/github/downloads/minoda-lab/universc/1.2.5-dev/total)
![GitHub release (latest by date)](https://img.shields.io/github/downloads/minoda-lab/universc/1.2.5.1/total)
![GitHub release (by tag)](https://img.shields.io/github/downloads/minoda-lab/universc/1.2.5.1/total)

![Docker CI](https://github.com/minoda-lab/universc/workflows/CI%20to%20Docker%20hub/badge.svg)
![Docker compose](https://github.com/minoda-lab/universc/workflows/Docker%20compose%20build/badge.svg)
Expand Down Expand Up @@ -94,7 +94,7 @@ and use this tool to process single-cell RNA-Seq data from FASTQ format.

**Package**

UniverSC version 1.2.5-dev
UniverSC version 1.2.5.1

**Maintainers**

Expand Down Expand Up @@ -139,15 +139,17 @@ Once you have a docker image installed on your system, you can run the applicabl

### Nextflow users

A [nextflow](https://www.nextflow.io/) custom [module](https://nf-co.re/modules) is being developed for the [nf-core](https://nf-co.re) community. It will be available to use in nf-core [pipelines](https://nf-co.re/pipelines).
A [nextflow](https://www.nextflow.io/) custom [module](https://nf-co.re/modules) is has been developed for the [nf-core](https://nf-co.re) community.
It will be release open-source to use in nf-core [pipelines](https://nf-co.re/pipelines).

See the issue and pull request for details:
See the issue and pull request for more details:

[https://github.com/nf-core/modules/issues/1644](https://github.com/nf-core/modules/issues/1644)

[https://github.com/nf-core/modules/pull/1706](https://github.com/nf-core/modules/pull/1706)

We plan to make this available in the near future. If you are interested in using it or contributing to development, please contact the maintainers. Thank you!
We welcome feedback on these tools. If you are interested in using it or contributing to
development of nextflow pipelines, please contact the maintainers. Thank you!

## Purpose

Expand Down Expand Up @@ -375,7 +377,7 @@ A flexible cross-platform single-cell data processing pipeline. _Nat Commun_ **1
number="1",
pages="1-7",
month="Nov",
note = {https://github.com/minoda-lab/universc package version 1.2.4},
note = {https://github.com/minoda-lab/universc package version 1.2.5.1},
URL = {https://doi.org/10.1038/s41467-022-34681-z}
}
```
Expand All @@ -385,7 +387,7 @@ The preprint can also be found here:
Kelly, S.T., Battenberg K., Hetherington, N.A., Hayashi, K., and Minoda, A. (2021)
UniverSC: a flexible cross-platform single-cell data processing pipeline.
bioRxiv 2021.01.19.427209; doi: [https://doi.org/10.1101/2021.01.19.427209](https://doi.org/10.1101/2021.01.19.427209)
package version 1.2.5-dev. [https://github.com/minoda-lab/universc](https://github.com/minoda-lab/universc)
package version 1.2.5.1. [https://github.com/minoda-lab/universc](https://github.com/minoda-lab/universc)

```
@article {Kelly2021.01.19.427209,
Expand All @@ -398,7 +400,7 @@ package version 1.2.5-dev. [https://github.com/minoda-lab/universc](https://gith
abstract = {Single-cell RNA-sequencing analysis to quantify RNA molecules in individual cells has become popular owing to the large amount of information one can obtain from each experiment. We have developed UniverSC (https://github.com/minoda-lab/universc), a universal single-cell processing tool that supports any UMI-based platform. Our command-line tool enables consistent and comprehensive integration, comparison, and evaluation across data generated from a wide range of platforms.Competing Interest StatementThe authors have declared no competing interest.},
eprint = {https://www.biorxiv.org/content/early/2021/01/19/2021.01.19.427209.full.pdf},
journal = {{bioRxiv}},
note = {package version 1.2.5-dev},
note = {package version 1.2.5.1},
URL = {https://github.com/minoda-lab/universc},
}
Expand All @@ -411,8 +413,8 @@ The software can also be cited directly as a manual:
@Manual{,
title = {{UniverSC}: a flexible cross-platform single-cell data processing pipeline},
author = {S. Thomas Kelly, Kai Battenberg, Nicola A. Hetherington, Makoto Hayashi, and Aki Minoda},
year = {2022},
note = {package version 1.2.5-dev},
year = {2023},
note = {package version 1.2.5.1},
url = {https://github.com/minoda-lab/universc},
}
```
Expand Down Expand Up @@ -865,7 +867,7 @@ your systems administrator.

#### Pulling from remote DockerHub repository

We provide a docker image for UniverSC version 1.2.5-dev.
We provide a docker image for UniverSC version 1.2.5.1.

You can import it if you have docker installed.

Expand Down Expand Up @@ -973,14 +975,14 @@ cellrangerpath=`which cellranger`
if [[ ! -f test/cellranger_reference/cellranger-tiny-ref/3.0.0/star/SA ]] && [[ -f $(dirname $cellrangerpath)/cellranger-tiny-ref/3.0.0/star/SA ]]; then
rsync $(dirname $cellrangerpath)/cellranger-tiny-ref/3.0.0/star/SA test/cellranger_reference/cellranger-tiny-ref/3.0.0/star/SA
fi
if [[ ! -f test/cellranger_reference/cellranger-tiny-ref/1.2.5-dev/star/SA ]] && [[ -f $(dirname $cellrangerpath)/cellranger-tiny-ref/1.2.5-dev/star/SA ]]; then
rsync $(dirname $cellrangerpath)/cellranger-tiny-ref/1.2.5-dev/star/SA test/cellranger_reference/cellranger-tiny-ref/1.2.5-dev/star/SA
if [[ ! -f test/cellranger_reference/cellranger-tiny-ref/1.2.0/star/SA ]] && [[ -f $(dirname $cellrangerpath)/cellranger-tiny-ref/1.2.0/star/SA ]]; then
rsync $(dirname $cellrangerpath)/cellranger-tiny-ref/1.2.0/star/SA test/cellranger_reference/cellranger-tiny-ref/1.2.0/star/SA
fi
```

This creates a reference for Cell Ranger here:

- test/cellranger_reference/cellranger-tiny-ref/1.2.5-dev
- test/cellranger_reference/cellranger-tiny-ref/1.2.0

- test/cellranger_reference/cellranger-tiny-ref/3.0.0

Expand Down Expand Up @@ -1019,7 +1021,7 @@ gffread test/cellranger_reference/cellranger-tiny-ref/genes-1.2.0.gff3 -T -o tes
To generate new references we first remove the references imported.

```
rm -rf test/cellranger_reference/cellranger-tiny-ref/1.2.5-dev test/cellranger_reference/cellranger-tiny-ref/3.0.0
rm -rf test/cellranger_reference/cellranger-tiny-ref/1.2.0 test/cellranger_reference/cellranger-tiny-ref/3.0.0
```

We then generate references from the FASTA and GTF files as shown in the following examples:
Expand Down
Loading

0 comments on commit 35eaf68

Please sign in to comment.