Skip to content

Commit

Permalink
update readme with metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
sspathare97 committed Dec 12, 2022
1 parent 5ea6c3d commit e441357
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,14 @@ usage: giggle <command> [options]

giggle, v0.6.3
usage: giggle index -i <input files> -o <output dir> -f
options:
-s Files are sorted
-i Files to index (e.g. data/*.gz)
-o Index output directory
-f For reindex if output directory exists
options:
-s Files are sorted
-i Files to index (e.g. data/*.gz)
-o Index output directory
-m Metadata config file
-f For reindex if output directory exists

Learn more about the [Metadata config file here](experiments/metadata_index_query_filter)

### Searching

Expand All @@ -55,7 +58,9 @@ usage: giggle <command> [options]
-v give full record results
-f print results for files that match a pattern (regex CSV)
-g genome size for significance testing (default 3095677412)
-l list the files in the index
-l list the files in the index
-m load metadata index
-u query filter

### Example

Expand Down
2 changes: 1 addition & 1 deletion src/search.c
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ int search_help(int exit_code)
" -i giggle index directory\n"
" -r <regions (CSV)>\n"
" -q <query file>\n"
" -o give reuslts per record in the query file (omits empty results)\n"
" -o give results per record in the query file (omits empty results)\n"
" -c give counts by indexed file\n"
" -s give significance by indexed file (requires query file)\n"
" -v give full record results\n"
Expand Down

0 comments on commit e441357

Please sign in to comment.