Skip to content

Commit

Permalink
imporve docs / and READMe
Browse files Browse the repository at this point in the history
  • Loading branch information
gordonkoehn committed Nov 26, 2024
1 parent 314eaba commit 762b8ac
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ The V-Pipe Docker is designed to process a single `.bam` file and upload the res

## Project Organization

- `silo-input-transformer`: Is a rust based utility to handle the `fasta` to `ndjson` transformation and is here imported as a git submodule.
- `.github/workflows`: Contains GitHub Actions used for building, testing, and publishing.
install, and whether or not to mount the project directory into the container.
- `.vscode/settings.json`: Contains VSCode settings specific to the project, such as the Python interpreter to use and the maximum line length for auto-formatting.
Expand Down
3 changes: 2 additions & 1 deletion src/sr2silo/process.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ def pair_normalize_reads(
sam_data: str, output_fasta: Path, output_insertions: Path
) -> None:
"""
Pair and normalize all reads in a SAM file.
Pair and normalize (to clear text sequence using CIGAR)
all reads in a SAM file output FASTA and insertions files.
Note that the input SAM file must be read in
its entirety before calling this function,
Expand Down

0 comments on commit 762b8ac

Please sign in to comment.