Skip to content

Commit 4bff6e6

Browse files
author
Seqera AI
committed
Update README to reflect URL support in samplesheets
Documentation changes: - Remove mention of manual download_data.sh requirement - Add examples showing URL support in samplesheets - Clarify that data is automatically fetched from PDM database - Show examples for both local files and URLs (http/s3/ftp) Makes it clear users can use URLs directly without manual downloads.
1 parent 86a7744 commit 4bff6e6

1 file changed

Lines changed: 16 additions & 12 deletions

File tree

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -55,18 +55,25 @@ Create a comma-separated file with three columns:
5555
| Column | Description |
5656
|--------|-------------|
5757
| `sample` | Unique sample identifier |
58-
| `fastq1` | Path to R1 FASTQ file (gzipped) |
59-
| `fastq2` | Path to R2 FASTQ file (gzipped) |
58+
| `fastq1` | Path or URL to R1 FASTQ file (gzipped) |
59+
| `fastq2` | Path or URL to R2 FASTQ file (gzipped) |
6060

61-
**Example:**
61+
**Example with local files:**
6262
```csv
6363
sample,fastq1,fastq2
6464
PDX_001,/data/PDX_001_R1.fastq.gz,/data/PDX_001_R2.fastq.gz
6565
PDX_002,/data/PDX_002_R1.fastq.gz,/data/PDX_002_R2.fastq.gz
6666
PDX_003,/data/PDX_003_R1.fastq.gz,/data/PDX_003_R2.fastq.gz
6767
```
6868

69-
> **Note**: Files must be paired-end Illumina reads in gzipped FASTQ format
69+
**Example with URLs:**
70+
```csv
71+
sample,fastq1,fastq2
72+
PDX_001,https://example.com/data/PDX_001_R1.fastq.gz,https://example.com/data/PDX_001_R2.fastq.gz
73+
PDX_002,s3://bucket/PDX_002_R1.fastq.gz,s3://bucket/PDX_002_R2.fastq.gz
74+
```
75+
76+
> **Note**: Files must be paired-end Illumina reads in gzipped FASTQ format. Both local paths and URLs (http/https/s3/ftp) are supported.
7077
7178
### 2. Reference Genomes
7279

@@ -142,21 +149,18 @@ This runs with:
142149

143150
### Full Test
144151

145-
Test with real PDX WES data (requires downloading data first):
152+
Test with real PDX WES data from the PDM database:
146153

147154
```bash
148-
# Download test data (optional - you need to provide your own WES data)
149-
cd test_full/data/full
150-
bash download_data.sh
151-
152-
# Run full test
155+
# Run full test - data is automatically downloaded from PDM database
153156
nextflow run tylergross97/nextflow_xengsort -profile test_full,docker
154157
```
155158

156159
This runs with:
157-
- Real-world PDX WES data (2 samples)
160+
- Real-world PDX WES data (2 samples from PDM database)
161+
- Data automatically fetched via URLs (no manual download needed)
158162
- Production-level memory requirements (16-32 GB)
159-
- ~30-60 minute runtime (depending on data size)
163+
- ~30-60 minute runtime (depending on download speed and data size)
160164
- Outputs to `results_test_full/` directory
161165

162166
## ⚙️ Parameters

0 commit comments

Comments
 (0)