conn_podr: Make a connection to PHUSE Open Data Repository (PODR)

In phuse-org/podrapp: Common Functions for 'PHUSE' Open Data Repository

Make a connection to PHUSE Open Data Repository (PODR)

Description

This function will set a PODR connection within the 'podr_connection' option. Ideally, you shouldn't need to worry about this after it's set. Using the read_podr function will utilize the connection automatically by default.

Usage

conn_podr(
  username = NULL,
  userpwd = NULL,
  driver = "postgresql",
  server = "podr.phuse.global",
  port = "5432",
  database = "nihpo"
)

Arguments

username	provides user name for PODR database connection given as a character string
userpwd	provides user password for PODR user given as a character string
driver	is database driver defaults to "postgresql"
server	is server name in FQDN or IP address defaults to "podr.phuse.global"
port	is port number defaults to "5432"
database	is database name defaults to "nihpo"

Details

You will be prompted within the RStudio interface for your user name and password if you did not provides when setting the connection,

Value

Nothing - sets the 'podr_connection' option

Author(s)

Hanming Tu

Examples

## Not run: 
  conn_podr()   # require user to provide name and password interactively
  conn_podr('my_username','my_pwd')

## End(Not run)

phuse-org/podrapp documentation built on May 11, 2022, 12:37 a.m.