egh_connection: Connect to the EpiGraphHub database via SSH tunneling

In thegraphnetwork/r-epigraphhub: An EpiGraphHub package with useful functions and tools for epidemiological data analysis and access to free databases from various organizations

Connect to the EpiGraphHub database via SSH tunneling

Description

egh_connection connects to the EpiGraphHub database using a .env local file or by manually providing information.

Usage

egh_connection(
  auto_connect = TRUE,
  use_env = TRUE,
  path_env = ".env",
  user,
  password
)

Arguments

auto_connect	logical. Should the function use a default connection? Automatically calls the session terminal and makes the connection.
use_env	logical. Should the function use the parameters configured in a local .env file?
path_env	character. If use_env = TRUE, the user should provide a path to the local .env file.
user, password	if use_env = FALSE, please provide access parameters to the EpiGraphHub database.

Details

This function connects to the EpiGraphHub (https://epigraphhub.org) database via SSH tunneling. User is required to have a SSH key. Default connection parameter can be used or provided by the user. The user can load a local .env file or provide the parameters inside the egh_connection.

Warning

A Internet connection is needed to use this function.

Watch out for hardcoded login and password.

Examples

## Not run: 
egh_connection(auto_connect = TRUE, use_env = TRUE, path_env = ".env")
egh_connection(auto_connect = TRUE, use_env = FALSE, user = "user", password = "password")

## End(Not run)

thegraphnetwork/r-epigraphhub documentation built on May 23, 2022, 7:45 p.m.