get.hycom: Download HYCOM data

In HMMoce: Improved Analysis of Marine Animal Movement Data Using Hidden Markov Models

Description

get.hycom downloads HYbrid Coordinate Ocean Model (HYCOM) data for given temporal and spatial constraints of your data.

Usage

get.hycom(limits, time, vars = c("water_temp"), include_latlon = TRUE,
  filename = "", download.file = TRUE, dir = getwd(), depLevels = NULL)

Arguments

limits	A list of length 4; minlon, maxlon, minlat, maxlat. Longitude values are -180,180
time	A vector of length 2 with the minimum and maximum times in form as.Date(date).
vars	A list of variables to download. This can contain 'water_temp', 'water_u', 'water_v', 'salinity' or 'surf_el' but is not checked for errors.
include_latlon	Should the array of latitude and longitude values be included?
filename	An optional filename. If provided, then the data is downloaded to that file. Otherwise the data is not downloaded and the url is returned.
download.file	Logical. Should use the default download.file to query the server and download or use the optional curl. Some users may need to use curl in order to get this to work.
dir	is local directory where ncdf files should be downloaded to. default is current working directory. if enter a directory that doesn't exist, it will be created.
depLevels	is an integer describing which depth levels to download from Hycom (e.g. 1=surface). Default is NULL and all levels are downloaded.

Details

The method may return before the download is completed. It will continue to display progress until the download completes. Change the default download.file if the download is failing on your platform.

Value

The url used to extract the requested data from the NetCDF subset service.

Author(s)

Function originally written for R by Ben Jones (WHOI) and modified by Camrin Braun and Ben Galuardi.

References

https://hycom.org/

HMMoce documentation built on Nov. 17, 2017, 5:57 a.m.