## For links
library("BiocStyle")
## Track time spent on making the vignette
startTime <- Sys.time()
## Bib setup
library("RefManageR")
## Write bibliography information
bib <- c(
    R = citation(),
    BiocStyle = citation("BiocStyle")[1],
    data.table = citation("data.table")[1],
    stringr = citation("stringr")[1]
)
knitr::opts_chunk$set(
  collapse = TRUE,
    comment = "#>",
    error = FALSE,
    warning = FALSE,
    message = FALSE,
    crop = NULL
)

Introduction

lineagespot is a framework written in R, and aims to identify SARS-CoV-2 related mutations based on a single (or a list) of variant(s) file(s) (i.e., variant calling format). The method can facilitate the detection of SARS-CoV-2 lineages in wastewater samples using next generation sequencing, and attempts to infer the potential distribution of the SARS-CoV-2 lineages.

Quick start

Installation

lineagespot is distributed as a Bioconductor package and requires R (version "4.1"), which can be installed on any operating system from CRAN, and Bioconductor (version "3.14").

To install lineagespot package enter the following commands in your R session:

if (!requireNamespace("BiocManager", quietly = TRUE)) {
    install.packages("BiocManager")
}
BiocManager::install("lineagespot")
## Check that you have a valid Bioconductor installation
BiocManager::valid()

Raw data analysis

Example fastq files are provided through zenodo. For the pre processing steps of them, the bioinformatics analysis pipeline is provided here.

Running lineagespot

Once lineagespot is successfully installed, it can be loaded as follow:

library(lineagespot)

lineagespot can be run by calling one function that implements the overall pipeline:

results = lineagespot(vcf_folder = system.file("extdata", "vcf-files", 
                                                package = "lineagespot"),

                      gff3_path = system.file("extdata", 
                                              "NC_045512.2_annot.gff3", 
                                              package = "lineagespot"),

                      voc = c("B.1.1.7", "B.1.617.2", "B.1.351"))

Explore the results

The function returns three tables:

# overall table
head(results$variants.table)
# lineages' hits
head(results$lineage.hits)
# lineagespot report
head(results$lineage.report)

Session info {.unnumbered}

Here is the output of sessionInfo() on the system on which this document was compiled running pandoc r rmarkdown::pandoc_version():

sessionInfo()


nikopech/lineagespot documentation built on Dec. 28, 2021, 12:15 a.m.