Skip to content

Commit 778d680

Browse files
authored
Merge pull request #95 from sheynkman-lab/feat/test_data_config
docs: remove defunct sample data section from README.md
2 parents 99d76b0 + 85a3bbd commit 778d680

1 file changed

Lines changed: 0 additions & 35 deletions

File tree

README.md

Lines changed: 0 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -301,41 +301,6 @@ nextflow run /path/to/LRP2 --help
301301
> [!WARNING]
302302
> Please provide pipeline parameters via the CLI as shown or using the Nextflow `-params-file` option. Custom config files including those provided by the `-c` Nextflow option can be used to provide any configuration except for parameters.
303303
304-
## Sample Data
305-
306-
### Downloading Sample Data
307-
308-
Example sample data for testing the pipeline is available on Zenodo:
309-
310-
**Zenodo DOI:** [10.5281/zenodo.18065306](https://zenodo.org/records/18065306)
311-
312-
The sample dataset includes chromosome 22 data from a PacBio Iso-Seq experiment studying RBFOX2 splicing regulation:
313-
- `230801_pacbio_rbfox2_control_chr22.flnc.bam` - Control sample (chr22 only)
314-
- `230801_pacbio_rbfox2_RB-G5_chr22.flnc.bam` - RBFOX2 knockdown sample (chr22 only)
315-
316-
### Using Sample Data
317-
318-
An example samplesheet for the sample data is included in `sample_data/samplesheet.csv`. After downloading the BAM files from Zenodo, you can run the pipeline on the sample data:
319-
320-
```bash
321-
# Download sample data from Zenodo
322-
wget https://zenodo.org/records/18065306/files/230801_pacbio_rbfox2_control_chr22.flnc.bam
323-
wget https://zenodo.org/records/18065306/files/230801_pacbio_rbfox2_RB-G5_chr22.flnc.bam
324-
325-
# Move files to sample_data directory
326-
mv *.flnc.bam sample_data/
327-
328-
# Run pipeline with sample data
329-
nextflow run /path/to/LRP2 \
330-
--input sample_data/samplesheet.csv \
331-
--outdir results \
332-
--genome GRCh38.p14.v46 \
333-
-profile singularity
334-
```
335-
336-
> [!NOTE]
337-
> The sample data is restricted to chromosome 22 for RNA samples and only a subset of peptides for mass spec samples to reduce file size and computation time, making it ideal for testing the pipeline and becoming familiar with the workflow. We highly recommend trying out the sample data prior to running with your own data!
338-
339304
## Test Data
340305

341306
The pipeline includes test data for quick validation of the installation and functionality. Test data is located in the `test_data/` directory and includes subsetted paired RNA and mass spec data for ENCODE4 K562 and HepG2 samples.

0 commit comments

Comments
 (0)