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
... ...
@@ -24,7 +24,7 @@ Returns `NULL`.
24 24
 Save the current package configuration
25 25
 }
26 26
 \examples{
27
-\donttest{
27
+\dontrun{
28 28
 # after this, all downloads will default to commercial licenses
29 29
 # i.e. the resources that allow only academic use will be excluded:
30 30
 options(omnipath.license = 'commercial')
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
... ...
@@ -24,7 +24,7 @@ Returns `NULL`.
24 24
 Save the current package configuration
25 25
 }
26 26
 \examples{
27
-\dontrun{
27
+\donttest{
28 28
 # after this, all downloads will default to commercial licenses
29 29
 # i.e. the resources that allow only academic use will be excluded:
30 30
 options(omnipath.license = 'commercial')
Browse code

donttest -> dontrun in all docs

Türei Dénes authored on 23/07/2021 13:37:40
Showing1 changed files
... ...
@@ -24,7 +24,7 @@ Returns `NULL`.
24 24
 Save the current package configuration
25 25
 }
26 26
 \examples{
27
-\donttest{
27
+\dontrun{
28 28
 # after this, all downloads will default to commercial licenses
29 29
 # i.e. the resources that allow only academic use will be excluded:
30 30
 options(omnipath.license = 'commercial')
Browse code

docs rebuild

Türei Dénes authored on 10/04/2021 18:53:16
Showing1 changed files
... ...
@@ -11,11 +11,11 @@ omnipath_save_config(path = NULL, title = "default", local = FALSE)
11 11
 created if don't exist.}
12 12
 
13 13
 \item{title}{Save the config under this title. One config file might
14
-contain multple configurations, each identified by a title.}
14
+contain multiple configurations, each identified by a title.}
15 15
 
16 16
 \item{local}{Save into a config file in the current directory instead of
17
-a user level config file. When loading, the config in the current directory
18
-has prioroty over the user level config.}
17
+a user level config file. When loading, the config in the current
18
+directory has priority over the user level config.}
19 19
 }
20 20
 \value{
21 21
 Returns `NULL`.
Browse code

added (hopefully) all missing return values to docs

Türei Dénes authored on 11/03/2021 21:08:34
Showing1 changed files
... ...
@@ -17,6 +17,9 @@ contain multple configurations, each identified by a title.}
17 17
 a user level config file. When loading, the config in the current directory
18 18
 has prioroty over the user level config.}
19 19
 }
20
+\value{
21
+Returns `NULL`.
22
+}
20 23
 \description{
21 24
 Save the current package configuration
22 25
 }
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,31 @@
1
+% Generated by roxygen2: do not edit by hand
2
+% Please edit documentation in R/options.R
3
+\name{omnipath_save_config}
4
+\alias{omnipath_save_config}
5
+\title{Save the current package configuration}
6
+\usage{
7
+omnipath_save_config(path = NULL, title = "default", local = FALSE)
8
+}
9
+\arguments{
10
+\item{path}{Path to the config file. Directories and the file will be
11
+created if don't exist.}
12
+
13
+\item{title}{Save the config under this title. One config file might
14
+contain multple configurations, each identified by a title.}
15
+
16
+\item{local}{Save into a config file in the current directory instead of
17
+a user level config file. When loading, the config in the current directory
18
+has prioroty over the user level config.}
19
+}
20
+\description{
21
+Save the current package configuration
22
+}
23
+\examples{
24
+\donttest{
25
+# after this, all downloads will default to commercial licenses
26
+# i.e. the resources that allow only academic use will be excluded:
27
+options(omnipath.license = 'commercial')
28
+omnipath_save_config()
29
+}
30
+
31
+}