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

Update output.md #509

Merged
merged 1 commit into from
Nov 20, 2024
Merged
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- [#502](https://github.com/genomic-medicine-sweden/nallo/pull/502) - Changed the way of validating the samplesheet to remove outputing false errors with `ifEmpty`
- [#506](https://github.com/genomic-medicine-sweden/nallo/pull/506) - Updated documentation
- [#507](https://github.com/genomic-medicine-sweden/nallo/pull/507) - Changed the default value of `ch_hgnc_ids` to allow running without `--filter_variants_hgnc_ids` introduced in [#496](https://github.com/genomic-medicine-sweden/nallo/pull/443)
- [#509](https://github.com/genomic-medicine-sweden/nallo/pull/509) - Updated documentation to fix mistakes

### `Removed`

Expand Down
16 changes: 8 additions & 8 deletions docs/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,13 +142,13 @@ In general, annotated variant calls are output per family while unannotated call

[Paraphase](https://github.com/PacificBiosciences/paraphase) is used to call paralogous genes.

| Path | Description |
| -------------------------------------------------------------------- | ----------------------------------------- |
| `paraphase/{sample}/*.bam` | BAM file with reads from analysed regions |
| `paraphase/{sample}/*.bai` | Index of the BAM file |
| `paraphase/{sample}/*.json` | Summary of haplotypes and variant calls |
| `paraphase/{sample}/{sample}_paraphase_vcfs/{sample}_{gene}_vcf` | VCF file per gene |
| `paraphase/{sample}/{sample}_paraphase_vcfs/{sample}_{gene}_vcf.tbi` | Index of the VCF file |
| Path | Description |
| ----------------------------------------------------------------------- | ----------------------------------------- |
| `paraphase/{sample}/*.bam` | BAM file with reads from analysed regions |
| `paraphase/{sample}/*.bai` | Index of the BAM file |
| `paraphase/{sample}/*.json` | Summary of haplotypes and variant calls |
| `paraphase/{sample}/{sample}_paraphase_vcfs/{sample}_{gene}_vcf.gz` | VCF file per gene |
| `paraphase/{sample}/{sample}_paraphase_vcfs/{sample}_{gene}_vcf.gz.tbi` | Index of the VCF file |

### Repeats

Expand Down Expand Up @@ -222,7 +222,7 @@ In general, annotated variant calls are output per family while unannotated call

[Severus](https://github.com/KolmogorovLab/Severus) or [Sniffles](https://github.com/fritzsedlazeck/Sniffles) are used to call structural variants, while [HiFiCNV](https://github.com/PacificBiosciences/HiFiCNV) is used to call CNVs. HiFiCNV also produces copy number, depth, and MAF [visualization tracks](#visualization-tracks).

!!!info "Variant :white_check_markemerging strategies"
!!!info "Variant merging strategies"

SV and CNV calls are output unmerged per sample, while the family files are first merged between samples for SVs and CNVs separately, then the merged SV and CNV files are merged again, with priority given to coordinates from the SV calls.

Expand Down
Loading