File: updateObject-methods.Rd

package info (click to toggle)
r-bioc-xvector 0.46.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 572 kB
  • sloc: ansic: 4,970; makefile: 2
file content (43 lines) | stat: -rw-r--r-- 1,155 bytes parent folder | download | duplicates (6)
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
\name{updateObject-methods}
\alias{updateObject-methods}

\alias{updateObject,XVector-method}
\alias{updateObject,XIntegerViews-method}

\title{Update an object of a class defined in the XVector package to its
       current class definition}

\description{
  The XVector package provides an extensive collection of
  \code{\link[BiocGenerics]{updateObject}} methods for updating
  almost any instance of a class defined in the package.
}
\usage{
## Showing usage of method defined for XVector objects only (usage
## is the same for all methods).

\S4method{updateObject}{XVector}(object, ..., verbose=FALSE)
}

\arguments{
  \item{object}{
    Object to be updated. Many (but not all) XVector classes are supported.
    If no specific method is available for the object, then the default
    method (defined in the BiocGenerics package) is used.
    See \code{?\link[BiocGenerics]{updateObject}} for a description of
    the default method.
  }
  \item{..., verbose}{
    See \code{?\link[BiocGenerics]{updateObject}}.
  }
}

\value{
  Returns a valid instance of \code{object}.
}

\seealso{
  \code{\link[BiocGenerics]{updateObject}}
}

\keyword{manip}