... | ... |
@@ -4,13 +4,14 @@ |
4 | 4 |
\alias{omnipath_set_cachedir} |
5 | 5 |
\title{Change the cache directory} |
6 | 6 |
\usage{ |
7 |
-omnipath_set_cachedir(path) |
|
7 |
+omnipath_set_cachedir(path = NULL) |
|
8 | 8 |
} |
9 | 9 |
\arguments{ |
10 | 10 |
\item{path}{Character: path to the new cache directory. If don't exist, |
11 | 11 |
the directories will be created. If the path is an existing cache |
12 | 12 |
directory, the package's cache database for the current session will |
13 |
-be loaded from the database in the directory.} |
|
13 |
+be loaded from the database in the directory. If \code{NULL}, the |
|
14 |
+cache directory will be set to its default path.} |
|
14 | 15 |
} |
15 | 16 |
\value{ |
16 | 17 |
Returns \code{NULL}. |
... | ... |
@@ -22,6 +23,6 @@ Change the cache directory |
22 | 23 |
tmp_cache <- tempdir() |
23 | 24 |
omnipath_set_cachedir(tmp_cache) |
24 | 25 |
# restore the default cache directory: |
25 |
-omnipath_init_cache() |
|
26 |
+omnipath_set_cachedir() |
|
26 | 27 |
|
27 | 28 |
} |
1 | 1 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,27 @@ |
1 |
+% Generated by roxygen2: do not edit by hand |
|
2 |
+% Please edit documentation in R/cache.R |
|
3 |
+\name{omnipath_set_cachedir} |
|
4 |
+\alias{omnipath_set_cachedir} |
|
5 |
+\title{Change the cache directory} |
|
6 |
+\usage{ |
|
7 |
+omnipath_set_cachedir(path) |
|
8 |
+} |
|
9 |
+\arguments{ |
|
10 |
+\item{path}{Character: path to the new cache directory. If don't exist, |
|
11 |
+the directories will be created. If the path is an existing cache |
|
12 |
+directory, the package's cache database for the current session will |
|
13 |
+be loaded from the database in the directory.} |
|
14 |
+} |
|
15 |
+\value{ |
|
16 |
+Returns \code{NULL}. |
|
17 |
+} |
|
18 |
+\description{ |
|
19 |
+Change the cache directory |
|
20 |
+} |
|
21 |
+\examples{ |
|
22 |
+tmp_cache <- tempdir() |
|
23 |
+omnipath_set_cachedir(tmp_cache) |
|
24 |
+# restore the default cache directory: |
|
25 |
+omnipath_init_cache() |
|
26 |
+ |
|
27 |
+} |