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

Add conda install instructions to README #988

Merged
merged 1 commit into from
May 21, 2024
Merged

Add conda install instructions to README #988

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@
.DS_Store
target
project/project
.metals/
.vscode/
19 changes: 18 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,13 @@
fgbio
====

A set of tools to analyze genomic data with a focus on Next Generation Sequencing. This readme document is mostly for developers/contributors and those attempting to build the project from source.
A set of tools to analyze genomic data with a focus on Next Generation Sequencing.

This readme document is mostly for developers/contributors and those attempting to build the project from source.
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-->
* [Quick Installation](#quick-installation)
* [Goals](#goals)
* [Overview](#overview)
* [List of tools](#list-of-tools)
Expand All @@ -27,6 +30,20 @@ Detailed user documentation is available on the [project website](http://fulcrum

<!---toc end-->

# Quick Installation

The [conda](https://conda.io/) package manager (configured with [bioconda channels](https://bioconda.github.io/)) can be used to quickly install fgbio:

```
conda install fgbio
```

To install fgbio without extra dependencies (e.g. [R](https://www.r-project.org/)), use the command:

```
conda install fgbio-minimal
```

# Goals

There are many toolkits available for analyzing genomic data; fgbio does not aim to be all things to all people but is specifically focused on providing:
Expand Down
Loading