File: chainNetSyntenic.Rd

package info (click to toggle)
r-bioc-cner 1.18.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 18,188 kB
  • sloc: ansic: 23,458; sh: 13; makefile: 6
file content (90 lines) | stat: -rw-r--r-- 3,542 bytes parent folder | download | duplicates (4)
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
\name{chainNetSyntenic}
\alias{chainNetSyntenic}

\title{
  chainNetSyntenic
}
\description{
  Wrapper function of \emph{chainNetSyntenic}:
  Makes alignment nets out of chains and adds synteny info to net.
  This function doesn't work on Windows platform since Kent utilities only
  support Linux and Unix platforms.
}
\usage{
  chainNetSyntenic(allPreChain, assemblyTarget, assemblyQuery,
                   netSyntenicFile=paste0(sub("\\\.2bit$", "",
                                              basename(assemblyTarget),
                                              ignore.case = TRUE), ".",
                                          sub("\\\.2bit$", "",
                                              basename(assemblyQuery),
                                              ignore.case = TRUE),
                                              ".noClass.net"),
                   binaryChainNet="chainNet", binaryNetSyntenic="netSyntenic")
}

\arguments{
  \item{allPreChain}{
    \code{character}(1): file names of input \emph{allPreChain} file.
  }
  \item{assemblyTarget}{
    \code{character}(1): the file name of target assembly \emph{twoBit} file.
  }
  \item{assemblyQuery}{
    \code{character}(1): the file name of query assembly \emph{twoBit} file.
  }
  \item{netSyntenicFile}{
    \code{character}(1): file names of output \emph{netSyntenicFile} file.
  }
  \item{binaryChainNet}{
    \code{character}(1): the name/filename of the binary \command{chainNet}
    to call.
  }
  \item{binaryNetSyntenic}{
    \code{character}(1): the name/filename of the binary \command{netSyntenic}
    to call.
  }
}
\details{
  Add classification information using the database tables:
  actually this step is not necessary in this pipeline
  according to http://blog.gmane.org/gmane.science.biology.ucscgenome.general/month=20130301.
  The class information will only be used for Genome Browser.
  Since it needs some specific modification of the table names for 
  certain species, we skip this step now.
  If this step is done, then the generated \emph{class.net} is 
  the gzipped net file that you see in UCSC Downloads area.
}
\value{
  \code{character}(1): the file names of generated \emph{net} file.
}
\references{
  \url{http://hgdownload.cse.ucsc.edu/admin/exe/}
}
\author{
  Ge Tan
}

\seealso{
  \code{\link{chainPreNet}}
}
\examples{
  \dontrun{
  ## This example doesn't run because it requires two bit files and external
  ## Kent utilities.
    allPreChain <- file.path("/Users/gtan/OneDrive/Project/CSC/CNEr/axt",
                             "danRer10.hg38.all.pre.chain")
    assemblyTarget <- "/Users/gtan/OneDrive/Project/CSC/CNEr/2bit/danRer10.2bit"
    assemblyQuery <- "/Users/gtan/OneDrive/Project/CSC/CNEr/2bit/hg38.2bit"
    chainNetSyntenic(allPreChain, assemblyTarget, assemblyQuery,
                     netSyntenicFile=file.path(
                       "/Users/gtan/OneDrive/Project/CSC/CNEr/axt",
                                               paste0(sub("\\\.2bit$", "",
                                                      basename(assemblyTarget),
                                                      ignore.case = TRUE), ".",
                                                      sub("\\\.2bit$", "",
                                                      basename(assemblyQuery),
                                                      ignore.case = TRUE),
                                              ".noClass.net")),
                     binaryChainNet="chainNet", binaryNetSyntenic="netSyntenic")
  }
}