File: Args.Rd

package info (click to toggle)
gdata 3.0.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 964 kB
  • sloc: sh: 27; makefile: 15
file content (37 lines) | stat: -rw-r--r-- 907 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
36
37
\name{Args}
\alias{Args}
\title{Describe Function Arguments}
\description{
  Display function argument names and corresponding default values,
  formatted in two columns for easy reading.
}
\usage{
Args(name, sort=FALSE)
}
\arguments{
  \item{name}{a function or function name.}
  \item{sort}{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.
}
\note{
  Primitive functions like \code{sum} and \code{all} have no formal
  arguments. See the \code{\link{formals}} help page.
}
\author{Arni Magnusson}
\seealso{
  \code{Args} is a verbose alternative to \code{\link{args}}, based on
  \code{\link{formals}}.

  \code{\link{help}} also describes function arguments.
}
\examples{
Args(glm)
Args(scan)
Args(legend, sort=TRUE)
}
\keyword{programming}
\keyword{utilities}
\keyword{documentation}