Skip to content

Commit

Permalink
preparing for 0.8.1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
Will Rowe committed Oct 11, 2018
1 parent 0805bd6 commit 2f68050
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ conda install groot
### Source

`GROOT` is written in Go (v1.9) - to compile from source you will first need the [Go tool chain](https://golang.org/doc/install). Once you have it, try something like this to compile:
`GROOT` is written in Go (v1.10) - to compile from source you will first need the [Go tool chain](https://golang.org/doc/install). Once you have it, try something like this to compile:

```bash
# Clone this repository
Expand Down Expand Up @@ -73,7 +73,15 @@ groot index -i arg-annot.90 -o groot-index -l 100
# Align reads and report
groot align -i groot-index -f reads.fq | groot report
```
>note: you must run the index subcommand using your query read length (e.g. `-l 100` for 100bp reads)
>note: index the graph using a window size <= your maximum expected read length, so for 100bp reads, use `-l 100`
If you anticipate variable read lengths, index the graphs for containment searching:

```bash
# Create graphs and index for containment searching
groot index -i arg-annot.90 -o groot-index -l 100 --containment -j 0.5
```
>note: the above command will allow you to align reads of any length (up to `-l 100`) to the graphs, within a containment threshold of 0.5 (`-j 0.5`)

## Further Information & Citing
Expand Down
2 changes: 1 addition & 1 deletion src/version/version.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
package version

const VERSION = "0.8.0"
const VERSION = "0.8.1"

0 comments on commit 2f68050

Please sign in to comment.