File: dimNALT_-.Rd

package info (click to toggle)
r-cran-r.utils 2.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,864 kB
  • sloc: sh: 18; makefile: 6
file content (54 lines) | stat: -rw-r--r-- 1,416 bytes parent folder | download | duplicates (4)
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
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  dimNA.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{dimNA< -}
\alias{dimNA< -.default}
\alias{dimNA< -}
\alias{dimNA<-}
\alias{dimNA<-.default}

\title{Sets the dimension of an object with the option to infer one dimension automatically}

\description{
 Sets the dimension of an object with the option to infer one dimension automatically.
 If one of the elements in the dimension \code{\link[base]{vector}} is \code{\link[base]{NA}}, then its value
 is inferred from the length of the object and the other elements in the
 dimension vector.  If the inferred dimension is not an \code{\link[base]{integer}}, an
 error is thrown.
}

\usage{
\method{dimNA}{default}(x) <- value
}

\arguments{
  \item{x}{An R object.}
  \item{value}{\code{\link[base]{NULL}} of a positive \code{\link[base]{numeric}} \code{\link[base]{vector}} with one optional \code{\link[base]{NA}}.}
}

\value{
  Returns (invisibly) what \code{dim<-()} returns
  (see \code{\link[base]{dim}}() for more details).
}

\examples{
  x <- 1:12
  dimNA(x) <- c(2,NA,3)
  stopifnot(dim(x) == as.integer(c(2,2,3)))
}

\author{Henrik Bengtsson}

\seealso{
 \code{\link[base]{dim}}().
}



\keyword{file}
\keyword{IO}