Skip to content

Commit

Permalink
improve the wording
Browse files Browse the repository at this point in the history
  • Loading branch information
pdimens committed May 7, 2024
1 parent b28ac35 commit 90323a3
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,12 @@ This directory contains the Harpy python package. This contains the command-line
interface users interact with when they call `harpy qc ...`. It's where
file inputs are checked, validated, and which workflows are executed by snakemake.

This "part" of Harpy only has a dependency on `snakemake` and `rich-click` (and by
extension, `rich` and `click`).
This part of Harpy only has a dependency on `snakemake`, `rich-click` (and by
extension, `rich` and `click`), samtools, and bcftools.

## Contents
- `globalscripts`: scripts that are not expected to be run inside a container and copied to the conda PATH
- `reports`: RMarkdown files that are used to create the nice flexdashboard reports
- `scripts`: scripts with dependencies that require a conda/container to have its dependencies available. these get copied into the `workdir/scripts` folder of a workflow
- `snakefiles`: the snakefiles that govern the workflows for most harpy modules
- everything else: the components of the harpy command line interface

0 comments on commit 90323a3

Please sign in to comment.