File: utils-listFunctions.Rd

package info (click to toggle)
fbasics 4052.98-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,020 kB
  • sloc: ansic: 738; makefile: 14
file content (74 lines) | stat: -rw-r--r-- 1,395 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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
\name{listFunctions}
\alias{listFunctions}

\alias{countFunctions}
\alias{listIndex}


\title{List exported functions in a package}

\description{

  Utilities to list and count exported functions in a package, 
  list the contents of the description file of a package, and 
    
  Prints the content of an index file for a package (a list of the
  objects exported by a package).
}


\usage{
listFunctions(package, character.only = FALSE)
countFunctions(package, character.only = FALSE)

listIndex(package, character.only = FALSE)
}


\arguments{

  \item{package}{

    a literal character string or a character string denoting the name
    of a package.

  }
  \item{character.only}{

    a logical indicating whether 'package' can be assumed to be
    a character string.

  }
}

\value{

  for \code{listFunctions}, a character vector containing the names of
  the exported functions in a package,

  for \code{countFunctions}, a named numeric value giving the number of
  the exported functions in a package.

  \code{listIndex} doesn't return a useful value. It is used for the
  side effect of printing the description or index.

}

\note{
  
  Be aware that \code{listFunctions} and \code{countFunctions} attach
  the package to the search path. 

}

\seealso{
  \code{\link{packageDescription}}
}

\examples{
listFunctions("fBasics")
   
countFunctions("fBasics")
}

\keyword{package}