File: Args.Rd

package info (click to toggle)
gregmisc 2.0.6-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 1,712 kB
  • ctags: 379
  • sloc: perl: 5,142; asm: 127; sh: 30; makefile: 17
file content (35 lines) | stat: -rwxr-xr-x 788 bytes parent folder | download
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
\name{Args}
\alias{Args}
\title{
  Formatted Argument List of a Function
}
\description{
  Display function argument names and corresponding default values,
  formatted in two columns for easy reading.
}
\usage{
Args(name, sort.args = FALSE)
}
\arguments{
  \item{name}{a function or function name.}
  \item{sort.args}{whether arguments should be sorted.}
}
\value{
  A data frame with named rows and a single column called \code{value},
  containing the default value of each argument.
}
\author{Arni Magnusson \email{arnima@u.washington.edu}}
\seealso{
  \code{\link{args}},
  \code{\link{formals}},
  \code{\link{help}}.
}
\examples{
Args(glm)
Args(scan)
Args(legend)
}
% Programming
\keyword{programming}
\keyword{utilities}
\keyword{documentation}