diseasystore (version 0.3.1)

diseasyoption: Helper function to get options related to diseasy

Description

Helper function to get options related to diseasy

Usage

diseasyoption(option, class = NULL, namespace = NULL, .default = NULL)

Value

• If option is given, the most specific option within the diseasy framework for the given option and class.

• If option is missing, all options related to diseasy packages.

Arguments

option

(character(1))
Name of the option to get.

class

(character(1) or R6::R6class Diseasy* instance)
Either the classname or the object the option applies to.

namespace

(character(1))
The namespace of the option (e.g. "diseasy" or "diseasystore").

.default

(any)
The default value to return if no option is set.

Examples

  # Retrieve default option for source conn
  diseasyoption("source_conn")

  # Retrieve DiseasystoreGoogleCovid19 specific option for source conn
  diseasyoption("source_conn", "DiseasystoreGoogleCovid19")

  # Try to retrieve specific option for source conn for a non existent / un-configured diseasystore
  diseasyoption("source_conn", "DiseasystoreNonExistent") # Returns default source_conn

  # Try to retrieve specific non-existent option
  diseasyoption("non_existent", "DiseasystoreGoogleCovid19", .default = "Use this")