annotate_deaminations: Annotate deaminations to file

Description Usage Arguments Value

View source: R/annotate_deaminations.R

Description

annotate_deaminations exports ideafix variant classification results to a text file. It either writes them to a new tsv file or appends them to the input vcf file provided to ideafix.

Usage

1
2
3
4
5
6
7
annotate_deaminations(
  classification,
  format = "tsv",
  outfolder = ".",
  outname = "ideafix_labels",
  vcf_filename = NULL
)

Arguments

classification

tibble containing the classification generated by classify_variants. It is the object to be written.

format

character string indicating the output file format. Can be "tsv" or "vcf". Defaults to "tsv".

outfolder

character string naming the folder to write the file to. Defaults to current working directory (getwd).

outname

character string naming the output filename. Defaults to "ideafix_labels.txt" or "ideafix_labels.vcf", depending on format value .

vcf_filename

optional character string, only needed if format equals to "vcf". It indicates the path to the vcf file ideafix has been run over.

Value

None


mmaitenat/ideafix documentation built on Sept. 18, 2021, 7:55 a.m.