Browse code

logfile is disabled if the `omnipath.logfile` config option is `"none"`

Türei Dénes authored on 15/06/2021 00:46:39
Showing1 changed files
... ...
@@ -2,15 +2,16 @@
2 2
 % Please edit documentation in R/log.R
3 3
 \name{omnipath_logfile}
4 4
 \alias{omnipath_logfile}
5
-\title{Returns the path to the current OmnipathR log file}
5
+\title{Path to the current OmnipathR log file}
6 6
 \usage{
7 7
 omnipath_logfile()
8 8
 }
9 9
 \value{
10
-Character: path to the current logfile.
10
+Character: path to the current logfile, or \code{NULL} if no
11
+    logfile is available.
11 12
 }
12 13
 \description{
13
-Returns the path to the current OmnipathR log file
14
+Path to the current OmnipathR log file
14 15
 }
15 16
 \examples{
16 17
 omnipath_logfile()
Browse code

docs: added all missing return values

Türei Dénes authored on 10/03/2021 18:45:04
Showing1 changed files
... ...
@@ -6,6 +6,9 @@
6 6
 \usage{
7 7
 omnipath_logfile()
8 8
 }
9
+\value{
10
+Character: path to the current logfile.
11
+}
9 12
 \description{
10 13
 Returns the path to the current OmnipathR log file
11 14
 }
Browse code

added new man pages

Türei Dénes authored on 10/03/2021 14:32:26
Showing1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,19 @@
1
+% Generated by roxygen2: do not edit by hand
2
+% Please edit documentation in R/log.R
3
+\name{omnipath_logfile}
4
+\alias{omnipath_logfile}
5
+\title{Returns the path to the current OmnipathR log file}
6
+\usage{
7
+omnipath_logfile()
8
+}
9
+\description{
10
+Returns the path to the current OmnipathR log file
11
+}
12
+\examples{
13
+omnipath_logfile()
14
+# [1] "/home/denes/omnipathr/omnipathr-log/omnipathr-20210309-1642.log"
15
+
16
+}
17
+\seealso{
18
+\code{\link{omnipath_log}}
19
+}