Add usage instructions to the README

This commit is contained in:
coolneng 2021-05-04 01:28:49 +02:00
parent 6440816a87
commit ad8abcc4fc
Signed by: coolneng
GPG Key ID: 9893DA236405AF57
2 changed files with 15 additions and 1 deletions

View File

@ -33,3 +33,17 @@ nix-shell
After running these commands, you will find yourself in a shell that contains all the needed dependencies.
** Usage
An execution script that accepts 2 parameters is provided, the following command invokes it:
#+begin_src shell
./generation.sh <number of sequences> <number of reads>
#+end_src
- <number of sequences>: an integer that specifies the number of different sequences to generate
- <number of reads>: an integer that specifies the number of reads to perform on each sequence
The script will generate 2 files under the data directory:
| HVR.fastq | Contains the original CDR3 sequence |
| CuReSim-HVR.fastq | Contains CDR3 after the read simulation, with sequencing errors |

View File

@ -1,7 +1,7 @@
#!/bin/sh
usage() {
echo "usage: generation.sh <number of sequences> <number_of_reads>"
echo "usage: generation.sh <number of sequences> <number of reads>"
exit 1
}