diff --git a/README.md b/README.md index 15258b7..696d1cf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,41 @@ # seqBackup Logic for parsing Illumina headers and folders as well as for archiving reads. +Also handles Oxford Nanopore (MinKNOW) run folders. + +## Backing up a run + +Illumina (paired-end, demultiplexed later from the archived `Undetermined` reads): + +``` +backup_illumina --forward-reads .../Undetermined_S0_L001_R1_001.fastq.gz \ + --destination-dir /path/to/archive --sample-sheet .../sample_sheet.csv +``` + +Nanopore (single-end, already basecalled by MinKNOW). Point it at the MinKNOW +run folder (`_