datacubeInit: Initialization of the Datacube

Description Usage Arguments Value

View source: R/datacubeInit.R

Description

When the datacube is initialized it collects information about the running environment (e.g. OS, user) and the used git repository. Als a database connections is setup based on the information in the '.R.options' file.

Usage

1
2
datacubeInit(script, workdir, database = "datacube",
  optionsfile = "~/.R.options", setdir = TRUE)

Arguments

script

the name of the running script in which the function is called, this script must exists

workdir

the name of the project directory within the repository, this will be the R working directory

database

the name of the database to connect to, database credentials must exists in the optionsfiles

optionsfile

name of the optionsfile

setdir

if true the a setwd() is used to set the working directory

Value

this functions does not return anything

Calling this function also creates a data directory in the working directory when it not exists


jspijker/datacube documentation built on Oct. 26, 2019, 4:30 p.m.