1. OmnipathR
  2. man
  3. omnipath_reset_config.Rd
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
man/omnipath_reset_config.Rd
History View file @ae1e1c5
... ... 
@@ -21,7 +21,7 @@ The config as a list.
21 21 
 Restores the built-in default values of all config parameters
22 22 
 }
23 23 
 \examples{
24 
-\donttest{
24 
+\dontrun{
25 25 
 # restore the defaults and write them to the default config file:
26 26 
 omnipath_reset_config()
27 27 
 omnipath_save_config()
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
man/omnipath_reset_config.Rd
History View file @4f4626c
... ... 
@@ -21,7 +21,7 @@ The config as a list.
21 21 
 Restores the built-in default values of all config parameters
22 22 
 }
23 23 
 \examples{
24 
-\dontrun{
24 
+\donttest{
25 25 
 # restore the defaults and write them to the default config file:
26 26 
 omnipath_reset_config()
27 27 
 omnipath_save_config()
Browse code

v3.1.4

Türei Dénes authored on 20/08/2021 15:59:35
Showing1 changed files
man/omnipath_reset_config.Rd
History View file @dd914a6
... ... 
@@ -4,12 +4,15 @@
4 4 
 \alias{omnipath_reset_config}
5 5 
 \title{Restores the built-in default values of all config parameters}
6 6 
 \usage{
7 
-omnipath_reset_config(save = NULL)
7 
+omnipath_reset_config(save = NULL, reset_all = FALSE)
8 8 
 }
9 9 
 \arguments{
10 10 
 \item{save}{If a path, the restored config will be also saved
11 11 
 to this file. If TRUE, the config will be saved to the current default
12 12 
 config path (see \code{\link{omnipath_get_config_path}}).}
13 
+
14 
+\item{reset_all}{Reset to their defaults also the options already set in
15 
+the R options.}
13 16 
 }
14 17 
 \value{
15 18 
 The config as a list.
Browse code

donttest -> dontrun in all docs

Türei Dénes authored on 23/07/2021 13:37:40
Showing1 changed files
man/omnipath_reset_config.Rd
History View file @43627ca
... ... 
@@ -18,7 +18,7 @@ The config as a list.
18 18 
 Restores the built-in default values of all config parameters
19 19 
 }
20 20 
 \examples{
21 
-\donttest{
21 
+\dontrun{
22 22 
 # restore the defaults and write them to the default config file:
23 23 
 omnipath_reset_config()
24 24 
 omnipath_save_config()
Browse code

docs rebuild

Türei Dénes authored on 10/04/2021 18:53:16
Showing1 changed files
man/omnipath_reset_config.Rd
History View file @be7aed3
... ... 
@@ -9,7 +9,7 @@ omnipath_reset_config(save = NULL)
9 9 
 \arguments{
10 10 
 \item{save}{If a path, the restored config will be also saved
11 11 
 to this file. If TRUE, the config will be saved to the current default
12 
-config path (see `omnipath_get_config_path()`).}
12 
+config path (see \code{\link{omnipath_get_config_path}}).}
13 13 
 }
14 14 
 \value{
15 15 
 The config as a list.
Browse code

added new man pages

Türei Dénes authored on 10/03/2021 14:32:26
Showing1 changed files
man/omnipath_reset_config.Rd
History View file @17c08fe
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,30 @@
1 
+% Generated by roxygen2: do not edit by hand
2 
+% Please edit documentation in R/options.R
3 
+\name{omnipath_reset_config}
4 
+\alias{omnipath_reset_config}
5 
+\title{Restores the built-in default values of all config parameters}
6 
+\usage{
7 
+omnipath_reset_config(save = NULL)
8 
+}
9 
+\arguments{
10 
+\item{save}{If a path, the restored config will be also saved
11 
+to this file. If TRUE, the config will be saved to the current default
12 
+config path (see `omnipath_get_config_path()`).}
13 
+}
14 
+\value{
15 
+The config as a list.
16 
+}
17 
+\description{
18 
+Restores the built-in default values of all config parameters
19 
+}
20 
+\examples{
21 
+\donttest{
22 
+# restore the defaults and write them to the default config file:
23 
+omnipath_reset_config()
24 
+omnipath_save_config()
25 
+}
26 
+
27 
+}
28 
+\seealso{
29 
+\code{\link{omnipath_load_config}, \link{omnipath_save_config}}
30 
+}