Browse code

Renamed main functions, added more documentation and organized test funs

Panagiotis Moulos authored on 04/02/2021 17:17:18
Showing1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,30 @@
1
+\name{getsetDbPath}
2
+\alias{setDbPath}
3
+\alias{getDbPath}
4
+\title{Get and set sitadela default database path}
5
+\usage{
6
+    setDbPath(db = NULL)
7
+    getDbPath()
8
+}
9
+\arguments{
10
+    \item{db}{path to a valid SQLite database file.}
11
+}
12
+\value{
13
+    This function does not have a return value.
14
+}
15
+\description{
16
+    The \code{setDbPath} and \code{getDbPath} functions are 
17
+    used to set and get the path to a sitadela annotation
18
+    database. If not explicitly provided, it defaults to
19
+    \code{file.path(system.file(package="sitadela"),"annotation.sqlite")}.
20
+    Essentially, the setter function adds an option to the R
21
+    environment pointing to the desired path.
22
+}
23
+\examples{
24
+myPath <- "/home/me/test.sqlite"
25
+setDbPath(myPath)
26
+getDbPath()
27
+}
28
+\author{
29
+    Panagiotis Moulos
30
+}