Giter VIP home page Giter VIP logo

amplicr's Introduction

amplicR

An R package to process amplicon data

This package has a number of functions to filter, dereplicate and error and chimera check NGS reads stored in fastq files. From v2.6.0 amplicR implements a function to process paired end reads (data.proc.paired). This functionality has not being implemented in the raw2data.proc wrapper and manual calling of the single functions is needed to carry out the preceding steps in the analytical pipeline. Compatibility of down stream analyses should be preserved, but it has not being. The retained reads after the data processing described above (or your own reads if you have done this already in another way) can then be compared against reference sequences and the number of mismatch is reported. This may be useful when, for example, screening samples for particular taxa (e.g. a pathogen).

amplicR is mainly a wrapper of several functions provided by other R packages in order to automate some common analyses, so if you use it, please make sure to also cite the relevant packages (these are generally indicated in the documentation of amplicR's functions). To find out the correct citation for a package, you can use the function: citation("package_name") where you have to replace package_name with the actual name of the package you are interested into.

Quickstart

Install the package from version control from within R:

library(devtools) 
install_github("carlopacioni/amplicR") 

If you have not used devtools before, then you have to install it with

install.packages("devtools") 

If you are on Windows, before loading devtools, shut down R, download the Rtools executable file from CRAN webpage and run it.

Note that the Bioconductor packages, which are required dependencies for amplicR, are not currently installed along with the package. This may change in the future, but for now these can be installed (if not installed already) running the following:

library(amplicR)
setup()

Disclamer

All reasonable care has been taken to ensure that amplicR functions report the correct results. However there is no guarantee that the package is bug-free. Also, amplicR was developed on a machine running windows 7 and no testing on other OS has been conducted so far. I can't see any reason why it would not work on linux or mac, but if in doubt, you may want to replicate the results on a windows environment.

Documentation

Use help(amplicR) ?amplicR or ??amplicR to see a broad description of the package. Use help(package = "amplicR") to see the documentations available. Alternatively, a manual is available here and a tutorial is available here.

Citation

If you use amplicR, please cite: Pending

amplicr's People

Contributors

carlopacioni avatar

Watchers

James Cloos avatar  avatar

amplicr's Issues

deconv() doesn't currently deal with variable amplicon length

Thanks to Daithi Murray, I have realised that currently deconv() doesn't deal with amplicons of variable length as the reads where the primers/indexes were found are retained only if they match the expected length (Line 239-241 and 267-269). Need to change the approach here while still allowing for the search of either-or/both indexes.

Include sequence name

Currently sequences saved in Final_seqs and Collated_seqs are with no names. This creates problem in downstream analyses. Sequences saved in fasta files as output should have sensible names. It is potentially possible to resolve this problem by using unquesToFasta rather than writeFasta function. This way they would also keep abundance info

catch error when no samples pass the filter

Lines 195-200 throws an error when the number of samples that pass the fileter is zero. This is because fnSeqs is NULL and merge can't find anything to merge!

This only happens when no even one sample has a good read, which is very unlikely. Catch this error with stop()

fnSeqs <- unlist(lapply(derepReads, getnFiltered))
lsummary[[1]] <- merge(data.table(Sample=sample_names),
data.table(Sample=sample_names_fil,
nFiltered=fnSeqs),
all.x=TRUE,
by="Sample")

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.