mirnaCounts: Counting miRNAs, Cordero et al. PLoS One. 2012;7:e31630

View source: R/mirnaCounts.R

mirnaCountsR Documentation

Counting miRNAs, Cordero et al. PLoS One. 2012;7:e31630

Description

This function executes the docker container mrna8, which allows miRNAs counting.

Usage

mirnaCounts(
  group = c("sudo", "docker"),
  fastq.folder = getwd(),
  scratch.folder = "/data/scratch",
  mirbase.id = c("hsa", "mmu"),
  download.status = FALSE,
  adapter.type = c("ILLUMINA", "NEB"),
  trimmed.fastq = FALSE
)

Arguments

group

a character string. Two options: "sudo" or "docker", depending to which group the user belongs

fastq.folder

a character string indicating where mirna fastq are located

scratch.folder

a character string indicating the scratch folder where docker container will be mounted

mirbase.id

a character string indicating the mirbase prefix for the organism of interest, e.g. hsa for human or mmu for mouse

download.status

a boolean logical variable indicating if the latest mirbase database will be downloaded or the local mirbase 21 will be used. Default is FALSE

adapter.type

a character string. Two options: "ILLUMINA" or "NEB", depending to which miRNA library prep was used: ILLUMINA or NEB

trimmed.fastq

a boolean logical variable indicating if trimmed fastq are saved. Default is FALSE

Value

one file: annotated_genes.results, which is the annotated version of gene.results.

Author(s)

Raffaele Calogero

Examples

## Not run: 
   system("wget 130.192.119.59/public/test.mirnaCounts.zip")
   unzip("test.mirnaCounts.zip")
   setwd("test.mirnaCounts")
   library(docker4seq)
   mirnaCounts(group="docker",fastq.folder=getwd(),
             scratch.folder="/data/scratch",
             mirbase.id="hsa",download.status=FALSE,
             adapter.type="NEB", trimmed.fastq=FALSE)


## End(Not run)

kendomaniac/docker4seq documentation built on Sept. 3, 2024, 6:42 p.m.