Skip to content

Commit

Permalink
Trim down man page
Browse files Browse the repository at this point in the history
  • Loading branch information
xchang1 committed Nov 28, 2024
1 parent 7e52da4 commit af691b4
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 21 deletions.
24 changes: 14 additions & 10 deletions doc/man.md
Original file line number Diff line number Diff line change
Expand Up @@ -351,16 +351,6 @@ options:

Filter alignments by properties.

`vg filter --tsv-out` can be used to produce a TSV file of user-specified fields from the GAM file. For example,

`vg filter --tsv-out "name;mapping_quality" <alignment.gam>`

is the equivalent of

`vg view -aj <alignment.gam> | jq -r '[.name,.mapping_quality] | @tsv'`

To find which fields are stored in a GAM file, use [`vg view`](#view) to view the GAM as a JSON file.




Expand Down Expand Up @@ -798,6 +788,20 @@ snarl distance index options
```


## inject


```
usage: vg inject -x graph.xg [options] input.[bam|sam|cram] >output.gam
options:
-x, --xg-name FILE use this graph or xg index (required, non-XG formats also accepted)
-o, --output-format NAME output the alignments in NAME format (gam / gaf / json) [gam]
-t, --threads N number of threads to use
```


## map


Expand Down
10 changes: 0 additions & 10 deletions doc/vgmanmd.desc.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,3 @@ format conversions for graphs and alignments
# filter

Filter alignments by properties.

`vg filter --tsv-out` can be used to produce a TSV file of user-specified fields from the GAM file. For example,

`vg filter --tsv-out "name;mapping_quality" <alignment.gam>`

is the equivalent of

`vg view -aj <alignment.gam> | jq -r '[.name,.mapping_quality] | @tsv'`

To find which fields are stored in a GAM file, use [`vg view`](#view) to view the GAM as a JSON file.
2 changes: 1 addition & 1 deletion doc/vgmanmd.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
cmds = ['index', 'view', 'autoindex', 'pack', 'giraffe', 'map', 'call',
'mpmap', 'rna', 'chunk', 'stats', 'gbwt', 'paths', 'find', 'filter',
'construct', 'minimizer', 'haplotypes', 'deconstruct', 'convert',
'gamsort', 'surject', 'mod', 'prune', 'ids', 'sim', 'annotate']
'gamsort', 'inject', 'surject', 'mod', 'prune', 'ids', 'sim', 'annotate']
cmds.sort()

# parse short descriptions
Expand Down

1 comment on commit af691b4

@adamnovak
Copy link
Member

Choose a reason for hiding this comment

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

vg CI tests complete for branch docmd. View the full report here.

16 tests passed, 0 tests failed and 0 tests skipped in 17444 seconds

Please sign in to comment.