stacomi: stacomi Main launcher for program stacomi

View source: R/stacomi.R

stacomiR Documentation

stacomi Main launcher for program stacomi

Description

When database_expected=FALSE a connection to the database is not expected. Therefore test are run by calling examples object stored in Rdata. To change the language use Sys.setenv(LANG = 'fr') or Sys.setenv(LANG = 'en')

Usage

stacomi(database_expected=TRUE, datawd = "~", sch = "test")

Arguments

database_expected

Boolean, if TRUE pre launch tests will be run to test the connection validity

datawd

The data working directory

sch

The schema in the stacomi database default 'test'.

Value

Nothing, called for its side effect of loading

Author(s)

Cedric Briand cedric.briand@eptb-vilaine.fr

Examples


 require(stacomiR)
#launch stacomi 
 ## Not run:  
stacomi(database_expected=TRUE, datawd='~',sch= "iav")

## End(Not run)
# launch stacomi without connection to the database
stacomi(database_expected=FALSE)
# launch stacomi with options
options(
	stacomiR.dbname = "bd_contmig_nat",
	stacomiR.host = readline(prompt = "Enter host: "),
	stacomiR.port = "5432",
	stacomiR.user = readline(prompt = "Enter user: "),
	stacomiR.password = readline(prompt = "Enter password: ")
)
# another usefull option to print all queries run by stacomiR to the console
 options('stacomiR.printqueries'= TRUE)

stacomiR documentation built on May 29, 2024, 10:41 a.m.