Browse code

rest of the html docs; changed `\donttest` to `\dontrun` everywhere, as we really dont want these examples to run in docs build

Türei Dénes authored on 14/11/2021 16:33:58
Showing1 changed files
... ...
@@ -27,7 +27,7 @@ Invisibly returns the config as a list.
27 27
 Load the package configuration from a config file
28 28
 }
29 29
 \examples{
30
-\donttest{
30
+\dontrun{
31 31
 # load the config from a custom config file:
32 32
 omnipath_load_config(path = 'my_custom_omnipath_config.yml')
33 33
 }
Browse code

changed all dontrun to donttest - hopefully R CMD check respects these

Türei Dénes authored on 14/10/2021 13:30:16
Showing1 changed files
... ...
@@ -27,7 +27,7 @@ Invisibly returns the config as a list.
27 27
 Load the package configuration from a config file
28 28
 }
29 29
 \examples{
30
-\dontrun{
30
+\donttest{
31 31
 # load the config from a custom config file:
32 32
 omnipath_load_config(path = 'my_custom_omnipath_config.yml')
33 33
 }
Browse code

donttest -> dontrun in all docs

Türei Dénes authored on 23/07/2021 13:37:40
Showing1 changed files
... ...
@@ -27,7 +27,7 @@ Invisibly returns the config as a list.
27 27
 Load the package configuration from a config file
28 28
 }
29 29
 \examples{
30
-\donttest{
30
+\dontrun{
31 31
 # load the config from a custom config file:
32 32
 omnipath_load_config(path = 'my_custom_omnipath_config.yml')
33 33
 }
Browse code

docs: added all missing return values

Türei Dénes authored on 10/03/2021 18:45:04
Showing1 changed files
... ...
@@ -20,6 +20,9 @@ have prioroty over the user level config.}
20 20
 
21 21
 \item{...}{Passed to \code{yaml::yaml.load_file}.}
22 22
 }
23
+\value{
24
+Invisibly returns the config as a list.
25
+}
23 26
 \description{
24 27
 Load the package configuration from a config file
25 28
 }
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,32 @@
1
+% Generated by roxygen2: do not edit by hand
2
+% Please edit documentation in R/options.R
3
+\name{omnipath_load_config}
4
+\alias{omnipath_load_config}
5
+\title{Load the package configuration from a config file}
6
+\usage{
7
+omnipath_load_config(path = NULL, title = "default", user = FALSE, ...)
8
+}
9
+\arguments{
10
+\item{path}{Path to the config file.}
11
+
12
+\item{title}{Load the config under this title. One config file might
13
+contain multple configurations, each identified by a title. If the
14
+title is not available the first section of the config file will be
15
+used.}
16
+
17
+\item{user}{Force to use the user level config even if a config file
18
+exists in the current directory. By default, the local config files
19
+have prioroty over the user level config.}
20
+
21
+\item{...}{Passed to \code{yaml::yaml.load_file}.}
22
+}
23
+\description{
24
+Load the package configuration from a config file
25
+}
26
+\examples{
27
+\donttest{
28
+# load the config from a custom config file:
29
+omnipath_load_config(path = 'my_custom_omnipath_config.yml')
30
+}
31
+
32
+}