Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sfchen authored Oct 18, 2017
1 parent 195bad4 commit 5f7d977
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,8 @@ slicer -i <input_file_name> -l <how_many_lines_per_slice> -o <output_dir> --gzip

# Example
Assuming that you have a text file called `filename.for.test.data` with 400000 lines, you want to cut it to 4 slices (100000 lines for each). You'd like to gzip all the slices, keep the file extension `.data`, and store them in a folder `sliced`. You can use following command:
```
```shell
slicer -i filename.for.test.data -l 100000 -o sliced -e data -z -s
# split -l 100000 filename.for.test.data
```
Then you will get four files in the folder `sliced`:
```
Expand Down Expand Up @@ -74,4 +73,4 @@ options:
* Make sure you set the line number (-l xxxx, or --line=xxxx) correctly as a multiple of 4, since each record always has 4 lines.
* If you want to keep the `.fq` or `.fastq` file extension, you can set the extension by `--ext=fq` or `--ext=fastq`
* If your data are paired-end sequencing files, you can run this tool for the pair of files separately.
* If your data are paired-end sequencing files, and you enable the `simple_name` to use short file name. For read1, you can set the extension as R1.fq by `--ext=R1.fq`, and for read2 you can set R2.fq by `--ext=R2.fq`, then you will get the sliced files like `0001.R1.fq` or `0003.R2.fq`.
* If your data are paired-end sequencing files, and you enable the `simple_name` to use short file name. For read1, you can set the extension as R1.fq by `--ext=R1.fq`, and for read2 you can set R2.fq by `--ext=R2.fq`, then you will get the sliced files like `0001.R1.fq`, `0002.R2.fq`.

0 comments on commit 5f7d977

Please sign in to comment.