upgo_connect: Function to connect to UPGo server

In UPGo-McGill/upgo: Utility Functions for UPGo Lab Members

Description

upgo_connect opens a connection to the UPGo server and optionally adds tables from the server to the global environment.

Usage

upgo_connect(
  property = TRUE,
  property_inactive = FALSE,
  daily = TRUE,
  daily_inactive = FALSE,
  host = TRUE,
  host_inactive = FALSE,
  review = FALSE,
  review_user = FALSE,
  review_text = FALSE,
  geolocation = FALSE,
  ha_mapping = FALSE,
  registration = FALSE,
  remote = FALSE
)

Arguments

property	A logical scalar. Should the property table (named 'property_remote') be added to the global environment?
property_inactive	A logical scalar. Should the property_inactive table (named 'property_inactive_remote') be added to the global environment?
daily	A logical scalar. Should the daily table (named 'daily_remote') be added to the global environment?
daily_inactive	A logical scalar. Should the daily_inactive table (named 'daily_inactive_remote') be added to the global environment?
host	A logical scalar. Should the host table (named 'host_remote') be added to the global environment?
host_inactive	A logical scalar. Should the host_inactive table (named 'host_remote_all') be added to the global environment?
review	A logical scalar. Should the review table (named 'review_remote') be added to the global environment?
review_user	A logical scalar. Should the review_user table (named 'review_user_remote') be added to the global environment?
review_text	A logical scalar. Should the review_text table (named 'review_text_remote') be added to the global environment?
geolocation	A logical scalar. Should the geolocation table (named 'geolocation_remote') be added to the global environment?
ha_mapping	A logical scalar. Should the ha_mapping table (named 'ha_mapping_remote') be added to the global environment?
registration	A logical scalar. Should the registration table (named 'registration_remote') be added to the global environment?
remote	A logical scalar. Should a remote connection be opened even if only local tables are being connected?

Details

A function for connecting to the UPGo server. For the function to work, the variables 'PGHOST', 'PGUSER' and 'PGPASSWORD' need to be defined in the user's .Renviron file. A connection with the name 'con' will be added to the global environment. The function will also optionally add tables from the server to the global environment.

Value

The function returns no output, but makes assignments to the global environment.

UPGo-McGill/upgo documentation built on Nov. 20, 2021, 2:26 a.m.