File: findSettings.Settings.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 (50 lines) | stat: -rw-r--r-- 1,363 bytes parent folder | download | duplicates (5)
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
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  Settings.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{Settings$findSettings}
\alias{Settings$findSettings}
\alias{findSettings.Settings}
\alias{Settings.findSettings}
\alias{findSettings,Settings-method}

\title{Searches for the settings file in one or several directories}

\description{
  Searches for the settings file in one or several directories.
}

\usage{
## Static method (use this):
## Settings$findSettings(basename, paths=c(".", "~"), ...)

## Don't use the below:
\method{findSettings}{Settings}(static, basename, paths=c(".", "~"), ...)
}

\arguments{
 \item{basename}{A \code{\link[base]{character}} string of the basename of the settings file.}
 \item{paths}{A \code{\link[base]{vector}} of \code{\link[base]{character}} string specifying the directories to
   be searched.}
 \item{...}{Not used.}
}

\value{
  Returns the absolute pathname (\code{\link[base]{character}} string) of the first settings
  file found, otherwise \code{\link[base]{NULL}}.
}

\author{Henrik Bengtsson}

\seealso{
  For more information see \code{\link{Settings}}.
}


\keyword{internal}
\keyword{methods}
\keyword{programming}