Skip to content

Commit

Permalink
Generate docs files
Browse files Browse the repository at this point in the history
  • Loading branch information
Nobody committed May 10, 2024
1 parent 7067311 commit 9a45075
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/tools/AggregateSvPileup.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: AggregateSvPileup
## Overview
**Group:** Breakpoint and SV Tools

Merges nearby pileups of reads supporting putative breakpoints.
Aggregates and merges pileups that are likely to support the same breakpoint.

Takes as input the file of pileups produced by `SvPileup`. That file contains a list of breakpoints, each
consisting of a chromosome, position and strand for each side of the breakpoint, as well as quantified read support
Expand Down
2 changes: 1 addition & 1 deletion docs/tools/SvPileup.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: SvPileup
## Overview
**Group:** Breakpoint and SV Tools

Collates a pileup of putative structural variant supporting reads.
Collates pileups of reads over breakpoint events.

## Outputs

Expand Down
6 changes: 3 additions & 3 deletions docs/tools/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ title: fgsv tools

# fgsv tools

The following tools are available in fgsv version 0.2.0-c2ca29a.
The following tools are available in fgsv version 0.2.0-7067311.
## Breakpoint and SV Tools

Primary tools for calling and transforming breakpoints and SVs.

|Tool|Description|
|----|-----------|
|[AggregateSvPileup](AggregateSvPileup.md)|Merges nearby pileups of reads supporting putative breakpoints|
|[AggregateSvPileup](AggregateSvPileup.md)|Aggregates and merges pileups that are likely to support the same breakpoint|
|[FilterAndMerge](FilterAndMerge.md)|Filters and merges SVPileup output|
|[SvPileup](SvPileup.md)|Collates a pileup of putative structural variant supporting reads|
|[SvPileup](SvPileup.md)|Collates pileups of reads over breakpoint events|

## Utility Tools

Expand Down

0 comments on commit 9a45075

Please sign in to comment.