Skip to content

Commit 49e88fc

Browse files
authored
fix: errtype/err type inconsistency (#42)
* Write ERRTYPE instead of ERR_TYPE column header in truth.tsv Ensures truth and query tsv files use the same column names in each report. That enables easier downstream data processing. * Update Output docs for ERRTYPE column name While ERRTYPE is used in most variable names, ERR_TYPE is used only in this document and in the truth.tsv file. This change centers all references to this variable around the ERRTYPE name.
1 parent 286819f commit 49e88fc

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

docs/dev/09-Outputs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Reports detailed information regarding each variant.
4141
| ALT | string | Alternate allele of this variant. |
4242
| QUAL | float | Quality score of this variant. |
4343
| TYPE | categorical | Type of variant (REF/SNP/INS/DEL/CPX). |
44-
| ERR_TYPE | categorical | Classification error type (TP/FP/FN). |
44+
| ERRTYPE | categorical | Classification error type (TP/FP/FN). |
4545
| CREDIT | float | Fraction of partial credit (in terms of correctness) that this variant received. --credit-threshold determines whether it is a true or false positive. |
4646
| CLUSTER | integer | 0-based index of the cluster on the current haplotype of this contig containing this variant. |
4747
| SUPERCLUSTER | integer | 0-based index of the supercluster on this contig containing this variant. |
@@ -187,4 +187,4 @@ This file reports for each edit (where called query sequence differs from truth
187187

188188
# Output `.txt` Files
189189
### parameters.txt
190-
This file stores all internal and command-line parameters used by vcfdist (for reproducibility and debugging purposes). Each line stores a single parameter in the format `parameter = value`.
190+
This file stores all internal and command-line parameters used by vcfdist (for reproducibility and debugging purposes). Each line stores a single parameter in the format `parameter = value`.

src/print.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -674,7 +674,7 @@ void write_results(std::unique_ptr<phaseblockData> & phasedata_ptr) {
674674
std::string out_query_fn = g.out_prefix + "query.tsv";
675675
if (g.verbosity >= 1) INFO(" Writing query variant results to '%s'", out_query_fn.data());
676676
FILE* out_query = fopen(out_query_fn.data(), "w");
677-
fprintf(out_query, "CONTIG\tPOS\tHAP\tREF\tALT\tQUAL\tTYPE\tERR_TYPE"
677+
fprintf(out_query, "CONTIG\tPOS\tHAP\tREF\tALT\tQUAL\tTYPE\tERRTYPE"
678678
"\tCREDIT\tCLUSTER\tSUPERCLUSTER\tSYNC_GROUP\tREF_DIST\tQUERY_DIST\tLOCATION\n");
679679
for (std::string ctg : phasedata_ptr->contigs) {
680680

0 commit comments

Comments
 (0)