1
- [ ![ Crates.io] ( https://img.shields.io/crates/v/fasten )] ( https://crates.io/crates/fasten )
2
-
3
1
# Fasten
4
2
3
+ [ ![ Crates.io] ( https://img.shields.io/crates/v/fasten )] ( https://crates.io/crates/fasten )
4
+
5
5
A powerful manipulation suite for interleaved fastq files.
6
6
Executables can read/write to ` stdin ` and ` stdout ` , and they are compatible with the interleaved fastq format.
7
7
This makes it much easier to perform streaming operations using unix pipes.
8
8
9
9
## Synopsis
10
10
11
11
### read metrics
12
-
12
+
13
13
$ cat testdata/R1.fastq testdata/R2.fastq | \
14
14
fasten_shuffle | fasten_metrics | column -t
15
15
totalLength numReads avgReadLength avgQual
@@ -27,8 +27,6 @@ This makes it much easier to perform streaming operations using unix pipes.
27
27
800 8 100 19.53875
28
28
# No reads were actually filtered with cleaning, with --min-length=2
29
29
30
- _ etc_
31
-
32
30
## Installation
33
31
34
32
### Installation from source
@@ -43,18 +41,17 @@ After downloading, use the Rust executable `cargo` like so:
43
41
44
42
All executables will be in the directory ` fasten/target/release ` .
45
43
46
- _ note_ : there are some ` Makefile ` methods to help including
44
+ _ note_ : there are some ` Makefile ` methods to help including
47
45
48
46
* ` make all ` to make the following
49
47
* ` make release ` install fast executables
50
48
* ` make debug ` install executables quickly (although the executables will not be optimized)
51
49
* ` make fasten/doc ` compile lastest documents
52
50
* ` make clean ` uninstall local binaries
53
51
54
-
55
52
### Installation without ` git `
56
53
57
- You can also install Fasten straight from < https://crates.io > using the following command:
54
+ You can also install Fasten straight from < https://crates.io > using the following command:
58
55
59
56
cargo install fasten
60
57
@@ -71,7 +68,7 @@ All scripts accept the parameters, read uncompressed fastq format from stdin, an
71
68
72
69
## Documentation
73
70
74
- Please see the inline documentation at https://lskatz.github.io/fasten/fasten
71
+ Please see the inline documentation at < https://lskatz.github.io/fasten/fasten >
75
72
76
73
This documentation was built with ` cargo docs --no-deps `
77
74
@@ -121,4 +118,3 @@ that indicates that you are securing your analysis by "fasten"ing it (with a sil
121
118
## Acknowledgements
122
119
123
120
Thank you Henk Den Bakker for many helpful discussions around Rust, helping me name this software, and many other things.
124
-
0 commit comments