File: setSlots.Rd

package info (click to toggle)
r-bioc-biocbaseutils 1.8.0%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 196 kB
  • sloc: makefile: 2
file content (39 lines) | stat: -rw-r--r-- 980 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/internals.R
\name{setSlots}
\alias{setSlots}
\alias{replaceSlots}
\title{Convenience function to set slot values}
\usage{
setSlots(object, ..., check = TRUE)
}
\arguments{
\item{object}{An S4 object with slots to replace}

\item{...}{Slot name and value pairs either as named arguments
or a named list, e.g., \code{slotName = value}.}

\item{check}{logical(1L) Whether to run validObject after the slot
replacement}
}
\value{
The object input with updated slot data
}
\description{
Given the current object, the function \code{setSlots} will take name-value
pair inputs either as named arguments or a \code{list} and replace the values of
the specified slots. This is a convenient function for updating slots in
an S4 class object.
}
\examples{

setClass("A", representation = representation(slotA = "character"))

aclass <- new("A", slotA = "A")

setSlots(aclass, slotA = "B")

}
\author{
H. Pagès
}