Skip to content

Commit 298edd1

Browse files
committed
update webatlas references
1 parent 7e8ffb8 commit 298edd1

File tree

11 files changed

+63
-63
lines changed

11 files changed

+63
-63
lines changed

CITATION.cff

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
cff-version: 1.2.0
22
type: software
33
message: "If you use this repo, please cite it"
4-
title: "Vitessce Pipeline"
5-
url: "https://github.com/haniffalab/vitessce-pipeline"
4+
title: "WebAtlas Pipeline"
5+
url: "https://github.com/haniffalab/webatlas-pipeline"
66
doi: 10.5281/zenodo.7405818
77
authors:
88
- family-names: "Li"
@@ -11,7 +11,7 @@ authors:
1111
- family-names: "Horsfall"
1212
given-names: "Dave"
1313
orcid: "https://orcid.org/0000-0002-8086-812X"
14-
- family-names: "Basurto Lozada"
14+
- family-names: "Basurto-Lozada"
1515
given-names: "Daniela"
1616
orcid: "https://orcid.org/0000-0003-3943-8424"
1717
- family-names: "Prete"

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
[![python-tests](https://github.com/haniffalab/vitessce-pipeline/actions/workflows/tests-python.yml/badge.svg)](https://github.com/haniffalab/vitessce-pipeline/actions/workflows/tests-python.yml)
2-
[![codecov](https://codecov.io/gh/haniffalab/vitessce-pipeline/branch/main/graph/badge.svg?token=7HQVFH08WJ)](https://codecov.io/gh/haniffalab/vitessce-pipeline/branch/main)
1+
[![python-tests](https://github.com/haniffalab/webatlas-pipeline/actions/workflows/tests-python.yml/badge.svg)](https://github.com/haniffalab/webatlas-pipeline/actions/workflows/tests-python.yml)
2+
[![codecov](https://codecov.io/gh/haniffalab/webatlas-pipeline/branch/main/graph/badge.svg?token=7HQVFH08WJ)](https://codecov.io/gh/haniffalab/webatlas-pipeline/branch/main)
33

4-
# Vitessce Pipeline
4+
# WebAtlas Pipeline
55

6-
[![docs](https://img.shields.io/badge/Documentation-online-blue)](https://haniffalab.github.io/vitessce-pipeline)
7-
[![demo](https://img.shields.io/badge/Demos-view-blue)](https://haniffalab.github.io/vitessce-pipeline/demos.html)
6+
[![docs](https://img.shields.io/badge/Documentation-online-blue)](https://haniffalab.github.io/webatlas-pipeline)
7+
[![demo](https://img.shields.io/badge/Demos-view-blue)](https://haniffalab.github.io/webatlas-pipeline/demos.html)
88
[![doi](https://zenodo.org/badge/DOI/10.5281/zenodo.7405818.svg)](https://doi.org/10.5281/zenodo.7405818)
99

10-
This Nextflow pipeline processes spatial and single-cell experiment data for visualisation in [vitessce-app](https://github.com/haniffalab/vitessce-app). The pipeline generates data files for [supported data types](http://vitessce.io/docs/data-types-file-types/), and builds a [view config](http://vitessce.io/docs/view-config-json/).
10+
This Nextflow pipeline processes spatial and single-cell experiment data for visualisation in [webatlas-app](https://github.com/haniffalab/webatlas-app). The pipeline generates data files for [supported data types](http://vitessce.io/docs/data-types-file-types/), and builds a [view config](http://vitessce.io/docs/view-config-json/).
1111

1212

1313
## Usage
1414

1515
The pipeline can handle data from `h5ad` files, image `tif` files, SpaceRanger output, Xenium output and MERSCOPE output. It can also generate image files from data files.
1616

17-
Running the pipeline requires a `parameters file` that defines configuration options and the data to be processed.
18-
Full instructions and parameters definitions for this files are available in the [documentation](https://haniffalab.com/vitessce-pipeline/setup.html)
17+
Running the pipeline requires a parameters file that defines configuration options and the data to be processed.
18+
Full instructions and parameters definitions for this files are available in the [documentation](https://haniffalab.com/webatlas-pipeline/setup.html)
1919

20-
A `parameters file` looks like
20+
A parameters file looks like
2121

2222
```yaml
2323
outdir: "/path/to/output/"
@@ -57,4 +57,4 @@ nextflow run main.nf -params-file /path/to/run-params.yaml -entry Full_pipeline
5757
```
5858

5959

60-
`Parameters file` templates are available in the `templates` directory.
60+
Parameters file templates are available in the `templates` directory.

docker/build-docker-imgs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@
88

99
VERSION=0.0.1
1010

11-
docker build --platform=linux/amd64 -t haniffalab/vitessce-pipeline:${VERSION} -f ./Dockerfile .
11+
docker build --platform=linux/amd64 -t haniffalab/webatlas-pipeline:${VERSION} -f ./Dockerfile .

nextflow.config

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ singularity.enabled = false
22
singularity.autoMounts = false
33

44
docker.enabled = true
5-
process.container = 'haniffalab/vitessce-pipeline:0.0.1'
5+
process.container = 'haniffalab/webatlas-pipeline:0.0.1'
66

77
// see https://www.nextflow.io/docs/latest/config.html#scope-aws
88
aws {

sphinx/citing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Cite as
1515

1616
.. raw:: html
1717

18-
<p><b><i>Li, Tong, Horsfall, Dave, & Basurto Lozada, Daniela. (2022). A nextflow pipeline to process spatial and single-cell data for Vitessce (0.1.0). Zenodo. https://doi.org/10.5281/zenodo.7405819</i></b></p>
18+
<p><b><i>Li, Tong, Horsfall, Dave, & Basurto-Lozada, Daniela. (2022). A nextflow pipeline to process spatial and single-cell data for Vitessce (0.1.0). Zenodo. https://doi.org/10.5281/zenodo.7405819</i></b></p>
1919

2020
Bibtex
2121
------
@@ -25,7 +25,7 @@ Bibtex
2525
@software{li_tong_2022_7405819,
2626
author = {Li, Tong and
2727
Horsfall, Dave and
28-
Basurto Lozada, Daniela},
28+
Basurto-Lozada, Daniela},
2929
title = {{A nextflow pipeline to process spatial and single-
3030
cell data for Vitessce}},
3131
month = dec,

sphinx/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
# -- Project information -----------------------------------------------------
2020

21-
project = "vitessce-pipeline"
21+
project = "webatlas-pipeline"
2222
copyright = "2022, Haniffa Lab"
2323
author = "Haniffa Lab"
2424

sphinx/demos.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@ Human Hindlimb
99
- Visium:
1010

1111
- `Sample
12-
1 <https://vitessce-app.cog.sanger.ac.uk/latest/index.html?config=https://hindlimb.cog.sanger.ac.uk/datasets/Visium/0.0.1/Hindlimb_visium_1_Visium_1_config.json>`__
12+
1 <https://webatlas.cog.sanger.ac.uk/latest/index.html?config=https://hindlimb.cog.sanger.ac.uk/datasets/Visium/0.0.1/Hindlimb_visium_1_Visium_1_config.json>`__
1313
- `Sample
14-
2 <https://vitessce-app.cog.sanger.ac.uk/latest/index.html?config=https://hindlimb.cog.sanger.ac.uk/datasets/Visium/0.0.1/Hindlimb_visium_2_Visium_2_config.json>`__
14+
2 <https://webatlas.cog.sanger.ac.uk/latest/index.html?config=https://hindlimb.cog.sanger.ac.uk/datasets/Visium/0.0.1/Hindlimb_visium_2_Visium_2_config.json>`__
1515
- `Sample
16-
3 <https://vitessce-app.cog.sanger.ac.uk/latest/index.html?config=https://hindlimb.cog.sanger.ac.uk/datasets/Visium/0.0.1/Hindlimb_visium_3_Visium_3_config.json>`__
16+
3 <https://webatlas.cog.sanger.ac.uk/latest/index.html?config=https://hindlimb.cog.sanger.ac.uk/datasets/Visium/0.0.1/Hindlimb_visium_3_Visium_3_config.json>`__
1717

18-
- `ISS <https://vitessce-app.cog.sanger.ac.uk/dev/index.html?config=https://bayraktar.cog.sanger.ac.uk/iss/0.0.1/ISS_hindlimb_1_config.json>`__
19-
- `scRNAseq <https://vitessce-app.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/hindlimb/scRNAseq/0.0.1/Hindlimb_scRNAseq_1_config.json>`__
18+
- `ISS <https://webatlas.cog.sanger.ac.uk/dev/index.html?config=https://bayraktar.cog.sanger.ac.uk/iss/0.0.1/ISS_hindlimb_1_config.json>`__
19+
- `scRNAseq <https://webatlas.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/hindlimb/scRNAseq/0.0.1/Hindlimb_scRNAseq_1_config.json>`__
2020

2121
Human Whole Embryo
2222
~~~~~~~~~~~~~~~~~~
2323

24-
- `Visium <https://vitessce-app.cog.sanger.ac.uk/latest/index.html?config=https://hindlimb.cog.sanger.ac.uk/datasets/Visium/0.0.1/Hindlimb_visium_4_config.json>`__
24+
- `Visium <https://webatlas.cog.sanger.ac.uk/latest/index.html?config=https://hindlimb.cog.sanger.ac.uk/datasets/Visium/0.0.1/Hindlimb_visium_4_config.json>`__
2525

2626
Fetal Immune
2727
~~~~~~~~~~~~
@@ -31,40 +31,40 @@ Fetal Immune
3131
- Fetal liver:
3232

3333
- `Sample
34-
1 <https://vitessce-app.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-liver/visium/0.0.1/visium_1_config.json>`__
34+
1 <https://webatlas.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-liver/visium/0.0.1/visium_1_config.json>`__
3535
- `Sample
36-
2 <https://vitessce-app.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-liver/visium/0.0.1/visium_2_config.json>`__
36+
2 <https://webatlas.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-liver/visium/0.0.1/visium_2_config.json>`__
3737
- `Sample
38-
3 <https://vitessce-app.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-liver/visium/0.0.1/visium_3_config.json>`__
38+
3 <https://webatlas.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-liver/visium/0.0.1/visium_3_config.json>`__
3939

4040
- Fetal spleen:
4141

4242
- `Sample
43-
1 <https://vitessce-app.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-spleen/visium/0.0.1/visium_1_config.json>`__
43+
1 <https://webatlas.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-spleen/visium/0.0.1/visium_1_config.json>`__
4444
- `Sample
45-
2 <https://vitessce-app.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-spleen/visium/0.0.1/visium_2_config.json>`__
45+
2 <https://webatlas.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-spleen/visium/0.0.1/visium_2_config.json>`__
4646
- `Sample
47-
3 <https://vitessce-app.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-spleen/visium/0.0.1/visium_3_config.json>`__
47+
3 <https://webatlas.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-spleen/visium/0.0.1/visium_3_config.json>`__
4848
- `Sample
49-
4 <https://vitessce-app.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-spleen/visium/0.0.1/visium_4_config.json>`__
49+
4 <https://webatlas.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-spleen/visium/0.0.1/visium_4_config.json>`__
5050

5151
- Fetal thymus:
5252

5353
- `Sample
54-
1 <https://vitessce-app.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-thymus/visium/0.0.1/visium_1_config.json>`__
54+
1 <https://webatlas.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-thymus/visium/0.0.1/visium_1_config.json>`__
5555
- `Sample
56-
2 <https://vitessce-app.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-thymus/visium/0.0.1/visium_2_config.json>`__
56+
2 <https://webatlas.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-thymus/visium/0.0.1/visium_2_config.json>`__
5757
- `Sample
58-
3 <https://vitessce-app.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-thymus/visium/0.0.1/visium_3_config.json>`__
58+
3 <https://webatlas.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/fetal-thymus/visium/0.0.1/visium_3_config.json>`__
5959

60-
- `scRNAseq <https://vitessce-app.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/scrnaseq/umap.json>`__
60+
- `scRNAseq <https://webatlas.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/fetal-immune/scrnaseq/umap.json>`__
6161

6262
Breast Cancer
6363
~~~~~~~~~~~~~
6464

65-
- `Xenium <https://vitessce-app.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/breast-cancer/xenium/config.json>`__
65+
- `Xenium <https://webatlas.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/breast-cancer/xenium/config.json>`__
6666

6767
Yolk sac
6868
~~~~~~~~
6969

70-
- `RNAScope <https://vitessce-app.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/yolk-sac/rnascope/hiplex.json>`__
70+
- `RNAScope <https://webatlas.cog.sanger.ac.uk/dev/index.html?theme=dark&config=https://haniffa.cog.sanger.ac.uk/yolk-sac/rnascope/hiplex.json>`__

sphinx/index.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
|Tests| |Sphinx| |Coverage| |DOI|
22

3-
.. |Tests| image:: https://github.com/haniffalab/vitessce-pipeline/actions/workflows/tests-python.yml/badge.svg
4-
:target: https://github.com/haniffalab/vitessce-pipeline/actions/workflows/tests-python.yml
5-
.. |Sphinx| image:: https://github.com/haniffalab/vitessce-pipeline/actions/workflows/sphinx-build.yml/badge.svg
6-
:target: https://github.com/haniffalab/vitessce-pipeline/actions/workflows/sphinx-build.yml
7-
.. |Coverage| image:: https://codecov.io/gh/haniffalab/vitessce-pipeline/branch/main/graph/badge.svg?token=7HQVFH08WJ
8-
:target: https://codecov.io/gh/haniffalab/vitessce-pipeline/branch/main
3+
.. |Tests| image:: https://github.com/haniffalab/webatlas-pipeline/actions/workflows/tests-python.yml/badge.svg
4+
:target: https://github.com/haniffalab/webatlas-pipeline/actions/workflows/tests-python.yml
5+
.. |Sphinx| image:: https://github.com/haniffalab/webatlas-pipeline/actions/workflows/sphinx-build.yml/badge.svg
6+
:target: https://github.com/haniffalab/webatlas-pipeline/actions/workflows/sphinx-build.yml
7+
.. |Coverage| image:: https://codecov.io/gh/haniffalab/webatlas-pipeline/branch/main/graph/badge.svg?token=7HQVFH08WJ
8+
:target: https://codecov.io/gh/haniffalab/webatlas-pipeline/branch/main
99
.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7405818.svg
1010
:target: https://doi.org/10.5281/zenodo.7405818
1111

12-
Vitessce Pipeline
12+
WebAtlas Pipeline
1313
=================
1414

15-
This Nextflow pipeline processes spatial and single-cell experiment data for visualisation in `Vitessce`_.
15+
This Nextflow pipeline processes spatial and single-cell experiment data for visualisation in `WebAtlas App`_.
1616
The pipeline generates data files for `supported data types`_, and builds a `view config`_.
1717

18-
.. _Vitessce: https://github.com/haniffalab/vitessce-app
18+
.. _WebAtlas App: https://github.com/haniffalab/webatlas-app
1919
.. _supported data types: https://vitessce.io/docs/data-types-file-types/
2020
.. _view config: https://vitessce.io/docs/view-config-json/
2121

@@ -43,9 +43,9 @@ Indices and tables
4343

4444
demos
4545
citing
46-
Source Code <https://github.com/haniffalab/vitessce-pipeline>
47-
Issue Tracker <https://github.com/haniffalab/vitessce-pipeline/issues>
48-
Frontend Client <https://github.com/haniffalab/vitessce-app>
46+
Source Code <https://github.com/haniffalab/webatlas-pipeline>
47+
Issue Tracker <https://github.com/haniffalab/webatlas-pipeline/issues>
48+
Frontend Client <https://github.com/haniffalab/webatlas-app>
4949

5050
.. toctree::
5151
:maxdepth: 2

sphinx/installation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Installation
77

88
::
99
10-
git clone git@github.com:haniffalab/vitessce-pipeline.git
11-
cd vitessce-pipeline
10+
git clone git@github.com:haniffalab/webatlas-pipeline.git
11+
cd webatlas-pipeline
1212
1313
2. Install nextflow by following the `documentation`_
1414
3. Install `Docker`_ and make sure it's in :code:`PATH`

sphinx/run.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Use ``-entry Process_files`` or ``-entry Process_images`` as you need.
3434
Further reading:
3535
----------------
3636

37-
Docker image pulling/local conda env creation are handled by nextflow.
37+
Docker image pulling/local conda env creation are handled by Nextflow.
3838
Please refer to
3939
`this <https://www.nextflow.io/docs/latest/getstarted.html>`__ for
4040
detailed information.
@@ -43,7 +43,7 @@ detailed information.
4343
Visualizing
4444
===========
4545

46-
Vitessce
46+
WebAtlas
4747
--------
4848

4949
The pipeline generates a Vitessce view config file for each processed dataset.
@@ -72,9 +72,9 @@ In this case, using `serve <https://www.npmjs.com/package/serve>`__, this is don
7272

7373
Your view configs should then be accessible at ``http://localhost:3000/{project}-{dataset}-config.json``.
7474

75-
You can then load them in a Vitessce instance like the `Vitessce app <https://github.com/haniffalab/vitessce-app>`__
76-
deployed at `<https://vitessce-app.cog.sanger.ac.uk/latest/index.html>`__.
75+
You can then load them in a Vitessce instance like the `WebAtlas app <https://github.com/haniffalab/webatlas-app>`__
76+
deployed at `<https://webatlas.cog.sanger.ac.uk/latest/index.html>`__.
7777

7878
Specify your locally served view config through the ``config`` parameter like
79-
``https://vitessce-app.cog.sanger.ac.uk/latest/index.html?config=http://localhost:3000/{project}-{dataset}-config.json``
79+
``https://webatlas.cog.sanger.ac.uk/latest/index.html?config=http://localhost:3000/{project}-{dataset}-config.json``
8080
and load this URL in your browser to visualize your data in a Vitessce viewer.

0 commit comments

Comments
 (0)