File: selectSome.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 (47 lines) | stat: -rw-r--r-- 1,173 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
40
41
42
43
44
45
46
47
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/showUtils.R
\name{selectSome}
\alias{selectSome}
\title{Select and return only some entries from a vector}
\usage{
selectSome(
  obj,
  maxToShow = 5,
  ellipsis = "...",
  ellipsisPos = c("middle", "end", "start"),
  quote = FALSE
)
}
\arguments{
\item{obj}{character() A vector to be abbreviated for display purposes}

\item{maxToShow}{numeric(1) The maximum number of values to show in the
output (default: 5)}

\item{ellipsis}{character(1) The symbol used to abbreviate values in the
vector (default: "...")}

\item{ellipsisPos}{character(1) The location for the ellipsis in the output,
by default in the \code{"middle"} but can be moved to either the \code{"end"} or
the \code{"start"}.}

\item{quote}{logical(1) Whether or not to add a single quote around the \code{obj}
input. This only works for character type inputs.}
}
\value{
An abbreviated output of \code{obj}
}
\description{
\code{selectSome} works well in \code{show} methods. It abbreviates a vector input
depending on the \code{maxToShow} argument.
}
\examples{

letters

selectSome(letters)

}
\author{
M. Morgan, H. Pagès
}