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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
\name{XRawList-comparison}
\alias{XRawList-comparison}
\alias{pcompare}
\alias{pcompare,XRawList,XRawList-method}
\alias{==,XRawList,XRawList-method}
\alias{<=,XRawList,XRawList-method}
\alias{duplicated.XRawList}
\alias{duplicated,XRawList-method}
\alias{match,XRawList,XRawList-method}
\alias{is.unsorted,XRawList-method}
\alias{order,XRawList-method}
\alias{rank,XRawList-method}
\title{Comparing and ordering the list elements of XRawList objects}
\description{
Methods for comparing and ordering the elements in one or more
\link{XRawList} objects.
}
\usage{
## Element-wise (aka "parallel") comparison of 2 XRawList objects
## --------------------------------------------------------------
\S4method{==}{XRawList,XRawList}(e1, e2)
\S4method{<=}{XRawList,XRawList}(e1, e2)
## duplicated()
## ------------
\S4method{duplicated}{XRawList}(x, incomparables=FALSE, ...)
## match()
## -------
\S4method{match}{XRawList,XRawList}(x, table, nomatch=NA_integer_, incomparables=NULL)
## order() and related methods
## ---------------------------
\S4method{is.unsorted}{XRawList}(x, na.rm=FALSE, strictly=FALSE)
\S4method{order}{XRawList}(..., na.last=TRUE, decreasing=FALSE,
method=c("auto", "shell", "radix"))
\S4method{rank}{XRawList}(x, na.last=TRUE,
ties.method=c("average", "first", "random", "max", "min"))
## Generalized element-wise (aka "parallel") comparison of 2 XRawList objects
## --------------------------------------------------------------------------
\S4method{pcompare}{XRawList,XRawList}(x, y)
}
\arguments{
\item{e1, e2, x, table, y}{
\link{XRawList} objects.
}
\item{incomparables}{
Not supported.
}
\item{...}{
For \code{duplicated}: currently no additional arguments are allowed.
For \code{order}: additional \link{XRawList} objects used for breaking
ties.
}
\item{nomatch}{
The value to be returned in the case when no match is found.
It is coerced to an \code{integer}.
}
\item{na.rm, na.last, method}{
Ignored.
}
\item{strictly}{
\code{TRUE} or \code{FALSE}. Should the check be for \emph{strictly}
increasing values?
}
\item{decreasing}{
\code{TRUE} or \code{FALSE}.
}
\item{ties.method}{
A character string specifying how ties are treated. Only \code{"first"}
and \code{"min"} are supported for now.
}
}
\details{
[TODO]
}
\author{H. Pagès}
\seealso{
\itemize{
\item The \link{XRawList} class.
\item \link[IRanges]{Ranges-comparison} in the IRanges
package for comparing and ordering ranges.
\item \code{\link{==}},
\code{\link[BiocGenerics]{duplicated}},
\code{\link[BiocGenerics]{unique}},
\code{\link[BiocGenerics]{match}},
\code{\link{\%in\%}},
\code{\link[BiocGenerics]{order}},
\code{\link[BiocGenerics]{sort}},
\code{\link[BiocGenerics]{rank}} for general information about
those functions.
}
}
\examples{
## TODO
}
\keyword{methods}
|
