enable_local: enable_local

In Maritimes/Mar.bycatch: Facilitates Extraction and Linking of Commercial and Observed Fisheries Data for the Maritimes

enable_local

Description

This function extracts all of the necessary oracle tables to a local folder so that the functions can be run locally.

Usage

enable_local(
  data.dir = NULL,
  oracle.username = "_none_",
  oracle.password = "_none_",
  oracle.dsn = "_none_",
  usepkg = "rodbc",
  force.extract = FALSE,
  ...
)

Arguments

data.dir	The default is your working directory. If you are hoping to load existing data, this folder should identify the folder containing your *.rdata files.
oracle.username	default is '_none_' This is your username for accessing oracle objects. If you have a value for oracle.username stored in your environment (e.g. from an rprofile file), this can be left out and that value will be used. If a value for this is provided, it will take priority over your existing value.
oracle.password	default is '_none_' This is your password for accessing oracle objects. If you have a value for oracle.password stored in your environment (e.g. from an rprofile file), this can be left out and that value will be used. If a value for this is provided, it will take priority over your existing value.
oracle.dsn	default is '_none_' This is your dsn/ODBC identifier for accessing oracle objects. If you have a value for oracle.dsn stored in your environment (e.g. from an rprofile file), this can be left and that value will be used. If a value for this is provided, it will take priority over your existing value.
usepkg	default is 'rodbc'. This indicates whether the connection to Oracle should use 'rodbc' or 'roracle' to connect. rodbc is slightly easier to setup, but roracle will extract data ~ 5x faster.
force.extract	default is FALSE This flag forces a re-extraction of all of the tables (rather than loading previously extracted versions from data.dir)
...	other arguments passed to methods

Author(s)

Mike McMahon, [e-mail]

Maritimes/Mar.bycatch documentation built on Aug. 18, 2024, 8:43 a.m.