File: saveAnywhere.Settings.Rd

package info (click to toggle)
r-cran-r.utils 2.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 2,936 kB
  • sloc: sh: 18; makefile: 6
file content (50 lines) | stat: -rwxr-xr-x 1,554 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{saveAnywhere.Settings}
\alias{saveAnywhere.Settings}
\alias{Settings.saveAnywhere}
\alias{saveAnywhere,Settings-method}

\title{Saves settings to file}

\description{
 Saves settings to file. If the settings was read from file, they are by default
 written back to the same file. If this was not the case, it defaults
 to the settings file in the home directory of the current user.
}

\usage{
\method{saveAnywhere}{Settings}(this, file=NULL, path="~", ...)
}

\arguments{
  \item{file}{A \code{\link[base]{character}} string or a \code{\link[base:connections]{connection}} where to write too.
     If \code{\link[base]{NULL}}, the file from which the settings were read is used. If
     this was not the case, argument \code{path} is used.}
  \item{path}{The default path, if no settings files are specified.
     This defaults to the current user's home directory.}
  \item{...}{Arguments passed to
     \code{\link[R.oo:save.Object]{save}()} in superclass Object.}
}

\value{
  Returns (invisibly) the pathname to the save settings file.
}

\author{Henrik Bengtsson}

\seealso{
  \code{\link[R.utils:loadAnywhere.Settings]{*loadAnywhere}()}.
  For more information see \code{\link{Settings}}.
}


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