VMS_get_recs: VMS_get_recs

In Maritimes/Mar.utils: A suite of functions used by a variety of Maritimes packages

VMS_get_recs

Description

This function extracts VMS data for a given timespan and area. A time buffer can be added returns other points that are not within the area of interest, but give context to the path.

Usage

VMS_get_recs(
  fn.oracle.username = "_none_",
  fn.oracle.password = "_none_",
  fn.oracle.dsn = "_none_",
  usepkg = "rodbc",
  dateStart = NULL,
  dateEnd = NULL,
  vrnList = NULL,
  hrBuffer = 4,
  minLon = NULL,
  maxLon = NULL,
  minLat = NULL,
  maxLat = NULL,
  rowNum = 50000,
  quietly = F
)

Arguments

fn.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.
fn.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.
fn.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.
dateStart	default is NULL. This is the start date ('YYYY-MM-DD') for your VMS data search
dateEnd	default is NULL. This is the end date ('YYYY-MM-DD') for your VMS data search. If this is left NULL, one year of data will be returned
vrnList	default is NULL. A vector or VRNs can be added so that the only positions returned match particular vessel(s).
hrBuffer	default is 4. This is the number of hours worth of VMS data you would like to pad your area search by. For example, if a vessel has a single VMS position in the results, padding it will add additional points before and after the intrusion which can illustrate what it was doing at the time.
minLon	default is NULL. This can be used to set a minimum Longitude
maxLon	default is NULL. This can be used to set a maximum Longitude
minLat	default is NULL. This can be used to set a minimum Latitude
maxLat	default is NULL. This can be used to set a maximum Latitude
rowNum	default is 50000. This is the maximum number of VMS records that can be extracted. It is in place to prevent crashing your application.
quietly	default is FALSE. This indicates whether or not information about the process should be shown.

Value

a dataFrame

Author(s)

Mike McMahon, [e-mail]

See Also

Other vms: VMS_clean_recs()

Maritimes/Mar.utils documentation built on May 5, 2024, 9:44 p.m.