Skip to content

Commit 516a4eb

Browse files
committed
Document live report portal
1 parent b9ea778 commit 516a4eb

3 files changed

Lines changed: 22 additions & 1 deletion

File tree

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Designed around the [Himes et al. (2014)](https://doi.org/10.1371/journal.pone.0
1515
- Docker, Singularity and AWS Batch profiles in `nextflow.config`.
1616
- Containerised FastAPI report portal under `cloud/report-portal/` for S3-hosted reports and Postgres run metadata.
1717
- Render Blueprint at `render.yaml` for a deployable FastAPI plus Postgres report portal.
18+
- Live Render smoke deployment: <https://rnaseq-report-portal.onrender.com/health>.
1819
- `nextflow_schema.json` for parameter discovery in Seqera Platform and other launch tooling.
1920
- Nextflow execution report, timeline, trace and DAG written to `results/pipeline_info/` on every run.
2021
- `scripts/validate_outputs.py` checks count matrices, DESeq2 output, plots, MultiQC and run metadata in CI.
@@ -147,6 +148,12 @@ Deploy shape:
147148
render.yaml -> Docker FastAPI service + managed Postgres + S3 presigned report links
148149
```
149150

151+
Live smoke deployment:
152+
153+
- Dashboard: <https://rnaseq-report-portal.onrender.com/>
154+
- Health: <https://rnaseq-report-portal.onrender.com/health>
155+
- Seeded artefact metadata: <https://rnaseq-report-portal.onrender.com/runs/synthetic-ci-001/artifacts/report>
156+
150157
## Parameters
151158

152159
| Parameter | Default | Description |
@@ -193,7 +200,7 @@ results/
193200

194201
- **2 samples per condition in the demo** - underpowered for reliable DE. The DESeq2 step runs and produces output, but with n=2 the results are illustrative, not statistically robust. Proper analysis requires ≥3 replicates per condition.
195202
- **CI uses synthetic data** - the public CI proves the full software path, not the biological conclusion. Real Himes/GSE52778 runs require external FASTQs, GRCh38 HISAT2 index and Gencode annotation files.
196-
- **AWS Batch proof status** - the profile and report portal are implemented, but no public real AWS Batch run artefact is committed yet. The report portal is the current cloud proof path until a real Batch run is published.
203+
- **AWS Batch proof status** - the profile and report portal are implemented, but no public real AWS Batch run artefact is committed yet. The live report portal is the current cloud proof path until a real Batch run is published.
197204
- **No STAR option** - only HISAT2 is implemented. Adding STAR as an alternative aligner would allow benchmarking on the same data.
198205

199206
## Licence

cloud/report-portal/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,12 @@ Open the Blueprint after the file is pushed:
9292
https://dashboard.render.com/blueprint/new?repo=https://github.com/Ekin-Kahraman/rnaseq-nextflow-pipeline
9393
```
9494

95+
Current live smoke deployment:
96+
97+
- Dashboard: <https://rnaseq-report-portal.onrender.com/>
98+
- Health: <https://rnaseq-report-portal.onrender.com/health>
99+
- Seeded artefact metadata: <https://rnaseq-report-portal.onrender.com/runs/synthetic-ci-001/artifacts/report>
100+
95101
## Tests
96102

97103
```bash

docs/cloud.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,3 +100,11 @@ https://dashboard.render.com/blueprint/new?repo=https://github.com/Ekin-Kahraman
100100
```
101101

102102
Fill the AWS secret fields only when presigned S3 URLs need to work against a real result bucket. The seeded demo run is enough to show the portal and metadata layer before wiring real S3 credentials.
103+
104+
Current live smoke deployment:
105+
106+
- Dashboard: <https://rnaseq-report-portal.onrender.com/>
107+
- Health: <https://rnaseq-report-portal.onrender.com/health>
108+
- Seeded artefact metadata: <https://rnaseq-report-portal.onrender.com/runs/synthetic-ci-001/artifacts/report>
109+
110+
This free Render service was created directly from the Docker portal root for fast public proof. The validated `render.yaml` remains the reproducible Postgres-backed deployment path.

0 commit comments

Comments
 (0)