Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[MRG] Update/doc tr #553

Merged
merged 2 commits into from
Oct 3, 2018
Merged

[MRG] Update/doc tr #553

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89f01a4
add gather csv col meanings
taylorreiter Oct 2, 2018
7315eaa
fix typos
taylorreiter Oct 2, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions doc/tutorials.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,14 @@ the recovered matches hit 73.1% of the query

```

If you use the `-o` flag, gather will write out a csv that contains additional information. The column headers and their meanings are:

+ intersect_bp: the approximate number of base pairs in common between the query and the match
+ f_orig_query: fraction of original query; the fraction of the original query that is contained within the match
+ f_match: fraction of match; the fraction of the match that is contained within the query
+ f_unique_to_query: fraction unique to query; the fraction of the query that uniquely overlaps with the match
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor comment: this is unique with respect to all previously output matches in the gather output.

+ f_unique_weighted: fraction unique to query weighted by abundance; fraction unique to query, weighted by abundance in the query

It is straightforward to build your own databases for use with `search`
and `gather`; ping us if you want us to write that up.

Expand Down