Skip to content

Commit 34cf741

Browse files
author
Seqera AI
committed
Configure test_full profile with default iGenomes references
- Add default reference genome paths from AWS iGenomes (s3://ngi-igenomes) - Set hg38_fasta to GRCh38 NCBI build - Set nsg_fasta to mm10 UCSC build - Makes test_full profile fully self-contained and runnable without additional parameters - Updated README to document the new default configuration - Users can still override with custom reference paths if needed (e.g., for NSG-adapted genome) This change makes the test_full profile much more user-friendly and enables testing in cloud environments (AWS, Seqera Platform) without local reference setup.
1 parent 6316b2e commit 34cf741

2 files changed

Lines changed: 13 additions & 14 deletions

File tree

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,10 @@ This runs with:
152152
Test with real PDX WES data from the PDM database:
153153

154154
```bash
155-
# Run full test - must provide reference genome paths
155+
# Run full test using default iGenomes references (recommended)
156+
nextflow run tylergross97/nextflow_xengsort -profile test_full,docker
157+
158+
# Or override with custom reference paths
156159
nextflow run tylergross97/nextflow_xengsort \
157160
-profile test_full,docker \
158161
--hg38_fasta s3://your-bucket/GRCh38.fa \
@@ -162,12 +165,14 @@ nextflow run tylergross97/nextflow_xengsort \
162165
This runs with:
163166
- Real-world PDX WES data (2 samples from PDM database)
164167
- FASTQ data automatically fetched via URLs (no manual download needed)
165-
- **Reference genomes must be provided** (not bundled due to large file sizes)
168+
- **Default reference genomes from AWS iGenomes** (s3://ngi-igenomes)
169+
- GRCh38 (NCBI build)
170+
- mm10 (UCSC build) - note: NSG-specific features may require custom reference
166171
- Production-level memory requirements (16-32 GB)
167172
- ~30-60 minute runtime (depending on download speed and data size)
168173
- Outputs to `results_test_full/` directory
169174

170-
> **Note**: Reference genomes are not included in the test profile due to their large size. You must provide paths to your own GRCh38 (human) and mm10/NSG (mouse) reference genomes via the `--hg38_fasta` and `--nsg_fasta` parameters.
175+
> **Note**: The `test_full` profile uses reference genomes from the public AWS iGenomes bucket by default. These are automatically accessible in cloud environments (AWS, Seqera Platform). For NSG-specific PDX models, consider using the NSG-adapted reference genome (see Reference Genomes section) by overriding with `--nsg_fasta`.
171176
172177
## ⚙️ Parameters
173178

nextflow.config

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -100,17 +100,11 @@ profiles {
100100
outdir_xengsort = "results_test_full/xengsort"
101101
outdir_multiqc = "results_test_full/multiqc"
102102

103-
// Reference genomes - MUST be provided via command line or launch parameters
104-
// These are not bundled due to large file sizes
105-
//
106-
// Example command:
107-
// nextflow run tylergross97/nextflow_xengsort \
108-
// -profile test_full,docker \
109-
// --hg38_fasta s3://your-bucket/GRCh38.fa \
110-
// --nsg_fasta s3://your-bucket/mm10_nsg.fa
111-
//
112-
// Leave as null to force users to specify
113-
// hg38_fasta and nsg_fasta inherit from main params block (null by default)
103+
// Reference genomes from ngi-igenomes (AWS iGenomes)
104+
// Using standard paths in s3://ngi-igenomes bucket (eu-west-1 region)
105+
// These can be overridden via command line if needed
106+
hg38_fasta = "s3://ngi-igenomes/igenomes/Homo_sapiens/NCBI/GRCh38/Sequence/WholeGenomeFasta/genome.fa"
107+
nsg_fasta = "s3://ngi-igenomes/igenomes/Mus_musculus/UCSC/mm10/Sequence/WholeGenomeFasta/genome.fa"
114108

115109
// Process settings for WES data
116110
fastp_args = "--detect_adapter_for_pe --cut_front --cut_tail --cut_mean_quality 20"

0 commit comments

Comments
 (0)