File: varnames.Rd

package info (click to toggle)
r-cran-coda 0.13-2-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 456 kB
  • sloc: makefile: 2
file content (37 lines) | stat: -rw-r--r-- 806 bytes parent folder | download | duplicates (10)
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
\name{varnames}
\alias{varnames}
\alias{varnames<-}
\alias{chanames}
\alias{chanames<-}
\title{Named dimensions of MCMC objects}

\usage{
varnames(x, allow.null=TRUE)
chanames(x, allow.null=TRUE)
varnames(x) <- value
chanames(x) <- value
}

\arguments{
\item{x}{an \code{mcmc} or \code{mcmc.list} object}
\item{allow.null}{Logical argument that determines whether the function may return NULL}
\item{value}{A character vector, or NULL}
}

\value{
   A character vector , or NULL.
}

\description{
   \code{varnames()} returns the variable names and \code{chanames}
   returns the chain names, or NULL if these are not set.  

   If \code{allow.null = FALSE} then \code{NULL} values will be
   replaced with canonical names.
}

\seealso{
   \code{\link{mcmc}},
   \code{\link{mcmc.list}}.
}
\keyword{manip}