File: selectSome.Rd

package info (click to toggle)
r-bioc-biobase 2.66.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,136 kB
  • sloc: ansic: 642; makefile: 3
file content (36 lines) | stat: -rw-r--r-- 1,222 bytes parent folder | download | duplicates (7)
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
\name{selectSome}
\alias{selectSome}
\title{Extract elements of a vector for concise rendering}
\description{
Extract the first and last several elements of a vector for concise
rendering; insert ellipses to indicate elided elements. This function
is primarily meant for developer rather than end-user use.
}
\usage{
selectSome(obj, maxToShow=5)
}
\arguments{
  \item{obj}{A vector.}
  \item{maxToShow}{The number of elements (including "...") to render.}
}
\details{
This function can be used in 'show' methods to give users exemplars of
the tokens used in a vector.  For example, an
\code{\link{ExpressionSet}} built from a yeast experiment might have
features enumerated using systematic gene names (e.g., YPR181C) or
standard gene names (e.g., SEC23).  The \code{\link{show}} method for
\code{\link{ExpressionSet}} uses \code{selectSome} to alert the user to
the tokens used, and thereby to indicate what vocabulary must be
understood to work with the feature names.
}

\value{
A string vector with at most \code{maxToShow} plus 1 elements,
where an ellipsis ("...") is included to indicate incompleteness
of the excerpt.
}
\author{Martin Morgan <mtmorgan@fhcrc.org>}
\examples{
selectSome(1:20)
}
\keyword{utilities}