File: startmitcr.Rd

package info (click to toggle)
r-cran-tcr 2.3.2%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, trixie
  • size: 2,316 kB
  • sloc: cpp: 187; makefile: 5
file content (45 lines) | stat: -rw-r--r-- 1,233 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/mitcr.R
\name{startmitcr}
\alias{startmitcr}
\title{Start MiTCR directly from the package.}
\usage{
startmitcr(
  .input = "",
  .output = "",
  ...,
  .file.path = "",
  .mitcr.path = "~/programs/",
  .mem = "4g"
)
}
\arguments{
\item{.input, .output}{Input and output files.}

\item{...}{Specify input and output files and arguments 
of the MITCR without first '-' to run it.}

\item{.file.path}{Path prepending to \code{.input} and \code{.output}.
If input and output is empty, but .file.path is specified, 
than process all files from the folder \code{.file.path}}

\item{.mitcr.path}{Path to MiTCR .jar file.}

\item{.mem}{Volume of memory available to MiTCR.}
}
\description{
Start the MiTCR tools directly from the package with given settings.
}
\details{
Don't use spaces in paths!
You should have insalled JDK 1.7 to make it works.
}
\examples{
\dontrun{
# Equal to
# java -Xmx8g -jar ~/programs/mitcr.jar -pset flex 
#      -level 2 ~/data/raw/TwA1_B.fastq.gz ~/data/mitcr/TwA1_B.txt
startmitcr('raw/TwA1_B.fastq.gz', 'mitcr/TwA1_B.txt', .file.path = '~/data/',
  pset = 'flex', level = 1, 'debug', .mitcr.path = '~/programs/', .mem = '8g')
}
}