Browse code

Updated to satisfy BiocCheck

Shians authored on 08/02/2019 00:11:00
Showing1 changed files
... ...
@@ -9,6 +9,9 @@ set_cellbench_cache_path(path = "./.CellBenchCache")
9 9
 \arguments{
10 10
 \item{path}{the path to where method caches should be stored}
11 11
 }
12
+\value{
13
+None
14
+}
12 15
 \description{
13 16
 Set CellBench cache path
14 17
 }
Browse code

Updated documentation

Shians authored on 07/02/2019 04:20:55
Showing1 changed files
... ...
@@ -22,5 +22,5 @@ set_cellbench_cache_path(file.path(tempdir(), ".CellBenchCache"))
22 22
 
23 23
 }
24 24
 \seealso{
25
-[cache_method()] for constructing cached methods.
25
+\code{\link{cache_method}} for constructing cached methods.
26 26
 }
Browse code

Updated documentation

Shians authored on 11/01/2019 00:54:50
Showing1 changed files
... ...
@@ -9,9 +9,6 @@ set_cellbench_cache_path(path = "./.CellBenchCache")
9 9
 \arguments{
10 10
 \item{path}{the path to where method caches should be stored}
11 11
 }
12
-\value{
13
-None
14
-}
15 12
 \description{
16 13
 Set CellBench cache path
17 14
 }
... ...
@@ -25,5 +22,5 @@ set_cellbench_cache_path(file.path(tempdir(), ".CellBenchCache"))
25 22
 
26 23
 }
27 24
 \seealso{
28
-[cache_method()]
25
+[cache_method()] for constructing cached methods.
29 26
 }
Browse code

Updated documentation

Shians authored on 18/12/2018 05:40:45
Showing1 changed files
... ...
@@ -17,9 +17,11 @@ Set CellBench cache path
17 17
 }
18 18
 \examples{
19 19
 \dontrun{
20
-set_cellbench_cache_path(".CellBenchCache")) # hidden folder in local path
20
+# hidden folder in local path
21
+set_cellbench_cache_path(".CellBenchCache"))
21 22
 }
22
-set_cellbench_cache_path(file.path(tempdir(), ".CellBenchCache")) # store in temp directory valid for this session
23
+# store in temp directory valid for this session
24
+set_cellbench_cache_path(file.path(tempdir(), ".CellBenchCache"))
23 25
 
24 26
 }
25 27
 \seealso{
Browse code

Updated documentation

Shians authored on 18/12/2018 04:08:40
Showing1 changed files
... ...
@@ -17,9 +17,9 @@ Set CellBench cache path
17 17
 }
18 18
 \examples{
19 19
 \dontrun{
20
-set_cellbench_cache(".CellBenchCache")) # hidden folder in local path
20
+set_cellbench_cache_path(".CellBenchCache")) # hidden folder in local path
21 21
 }
22
-set_cellbench_cache(file.path(tempdir(), ".CellBenchCache")) # store in temp directory valid for this session
22
+set_cellbench_cache_path(file.path(tempdir(), ".CellBenchCache")) # store in temp directory valid for this session
23 23
 
24 24
 }
25 25
 \seealso{
Browse code

Updated for BiocCheck compliance

Shians authored on 18/12/2018 03:50:52
Showing1 changed files
... ...
@@ -9,13 +9,17 @@ set_cellbench_cache_path(path = "./.CellBenchCache")
9 9
 \arguments{
10 10
 \item{path}{the path to where method caches should be stored}
11 11
 }
12
+\value{
13
+None
14
+}
12 15
 \description{
13 16
 Set CellBench cache path
14 17
 }
15 18
 \examples{
16 19
 \dontrun{
17
-set_cellbench_cache_path(path = ".CellBenchCache")
20
+set_cellbench_cache(".CellBenchCache")) # hidden folder in local path
18 21
 }
22
+set_cellbench_cache(file.path(tempdir(), ".CellBenchCache")) # store in temp directory valid for this session
19 23
 
20 24
 }
21 25
 \seealso{
Browse code

Updated documentation

Shians authored on 08/11/2018 02:50:20
Showing1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,23 @@
1
+% Generated by roxygen2: do not edit by hand
2
+% Please edit documentation in R/set_options.R
3
+\name{set_cellbench_cache_path}
4
+\alias{set_cellbench_cache_path}
5
+\title{Set CellBench cache path}
6
+\usage{
7
+set_cellbench_cache_path(path = "./.CellBenchCache")
8
+}
9
+\arguments{
10
+\item{path}{the path to where method caches should be stored}
11
+}
12
+\description{
13
+Set CellBench cache path
14
+}
15
+\examples{
16
+\dontrun{
17
+set_cellbench_cache_path(path = ".CellBenchCache")
18
+}
19
+
20
+}
21
+\seealso{
22
+[cache_method()]
23
+}