Bioconductor Code: Browse

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`.
                                      Save the current package configuration
+                                     }
                                      \examples{
                                     -\donttest{
                                     +\dontrun{
                                      # after this, all downloads will default to commercial licenses
                                      # i.e. the resources that allow only academic use will be excluded:
                                      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

man/omnipath_save_config.Rd

History View file @4f4626c

@@ -24,7 +24,7 @@ Returns `NULL`.
                                      Save the current package configuration
+                                     }
                                      \examples{
                                     -\dontrun{
                                     +\donttest{
                                      # after this, all downloads will default to commercial licenses
                                      # i.e. the resources that allow only academic use will be excluded:
                                      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

man/omnipath_save_config.Rd

History View file @43627ca

@@ -24,7 +24,7 @@ Returns `NULL`.
                                      Save the current package configuration
+                                     }
                                      \examples{
                                     -\donttest{
                                     +\dontrun{
                                      # after this, all downloads will default to commercial licenses
                                      # i.e. the resources that allow only academic use will be excluded:
                                      options(omnipath.license = 'commercial')

Browse code

docs rebuild

Türei Dénes authored on 10/04/2021 18:53:16
Showing1 changed files

man/omnipath_save_config.Rd

History View file @be7aed3

@@ -11,11 +11,11 @@ omnipath_save_config(path = NULL, title = "default", local = FALSE)
                                      created if don't exist.}
                                      \item{title}{Save the config under this title. One config file might
                                     -contain multple configurations, each identified by a title.}
                                     +contain multiple configurations, each identified by a title.}
                                      \item{local}{Save into a config file in the current directory instead of
                                     -a user level config file. When loading, the config in the current directory
                                     -has prioroty over the user level config.}
                                     +a user level config file. When loading, the config in the current
                                     +directory has priority over the user level config.}
+                                     }
                                      \value{
                                      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

man/omnipath_save_config.Rd

History View file @4319b67

@@ -17,6 +17,9 @@ contain multple configurations, each identified by a title.}
                                      a user level config file. When loading, the config in the current directory
                                      has prioroty over the user level config.}
+                                     }
                                     +\value{
                                     +Returns `NULL`.
                                     +}
                                      \description{
                                      Save the current package configuration
+                                     }

Browse code

added new man pages

Türei Dénes authored on 10/03/2021 14:32:26
Showing1 changed files

man/omnipath_save_config.Rd

History View file @17c08fe

                                     new file mode 100644
@@ -0,0 +1,31 @@
                                     +% Generated by roxygen2: do not edit by hand
                                     +% Please edit documentation in R/options.R
                                     +\name{omnipath_save_config}
                                     +\alias{omnipath_save_config}
                                     +\title{Save the current package configuration}
                                     +\usage{
                                     +omnipath_save_config(path = NULL, title = "default", local = FALSE)
                                     +}
                                     +\arguments{
                                     +\item{path}{Path to the config file. Directories and the file will be
                                     +created if don't exist.}
+                                    +
                                     +\item{title}{Save the config under this title. One config file might
                                     +contain multple configurations, each identified by a title.}
+                                    +
                                     +\item{local}{Save into a config file in the current directory instead of
                                     +a user level config file. When loading, the config in the current directory
                                     +has prioroty over the user level config.}
                                     +}
                                     +\description{
                                     +Save the current package configuration
                                     +}
                                     +\examples{
                                     +\donttest{
                                     +# after this, all downloads will default to commercial licenses
                                     +# i.e. the resources that allow only academic use will be excluded:
                                     +options(omnipath.license = 'commercial')
                                     +omnipath_save_config()
                                     +}
+                                    +
                                     +}