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.

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

Add DownsampleVcf tool #974

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,21 @@ A set of tools to analyze genomic data with a focus on Next Generation Sequencin
Detailed user documentation is available on the [project website](http://fulcrumgenomics.github.io/fgbio/) including [tool usage](http://fulcrumgenomics.github.io/fgbio/tools/latest) and [documentation of metrics produced](http://fulcrumgenomics.github.io/fgbio/metrics/latest). Detailed developer documentation can be found [here](http://javadoc.io/doc/com.fulcrumgenomics/fgbio_2.13).

<!---toc start-->
* [Goals](#goals)
* [Overview](#overview)
* [List of tools](#list-of-tools)
* [Building](#building)
* [Command line](#command-line)
* [Include fgbio in your project](#include-fgbio-in-your-project)
* [Contributing](#contributing)
* [Authors](#authors)
* [License](#license)
* [Sponsorship](#sponsorship)
- [fgbio](#fgbio)
- [Goals](#goals)
- [Overview](#overview)
- [List of tools](#list-of-tools)
- [Building](#building)
- [Cloning the Repository](#cloning-the-repository)
- [Running the build](#running-the-build)
- [Command line](#command-line)
- [Include fgbio in your project](#include-fgbio-in-your-project)
- [Contributing](#contributing)
- [Authors](#authors)
- [License](#license)
- [Sponsorship](#sponsorship)
- [Become a sponsor](#become-a-sponsor)
- [Sponsors](#sponsors)
Comment on lines +17 to +31
Copy link
Member

Choose a reason for hiding this comment

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

GitHub has TOC support so we could consider removing this maintenance burden.

https://github.blog/changelog/2021-04-13-table-of-contents-support-in-markdown-files/

Copy link
Contributor

Choose a reason for hiding this comment

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

VS code also automatically updates the TOC. I don't care either way.


<!---toc end-->

Expand Down Expand Up @@ -76,7 +81,7 @@ Below we highlight a few tools that you may find useful.
[Git LFS](https://git-lfs.github.com/) is used to store large files used in testing fgbio. In order to compile and run tests it is necessary to [install git lfs](https://git-lfs.github.com/). To retrieve the large files either:

1. Clone the repository _after_ installing git lfs, or
2. In a previously cloned repository run `git lfs pull` once
2. In a previously cloned repository run the follwing once: `git lfs install && git lfs pull`

After initial setup regular git commands (e.g. `pull`, `fetch`, `push`) will also operate on large files and no special handling is needed.

Expand Down
Loading
Loading