dc.argoSearch: FIXME: this function is in flux: do not use

Description Usage Arguments See Also

View source: R/argo.R

Description

FIXME: this function is in flux: do not use

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
dc.argoSearch(
  id = NULL,
  longitude = c(-180, 180),
  latitude = c(-90, 90),
  time = Sys.Date() + c(-7 * 86400, 0),
  server = "ftp://usgodae.org",
  destdir = ".",
  destfile,
  force = FALSE,
  dryrun = FALSE,
  debug = getOption("dcDebug", 0)
)

Arguments

id

character value holding the ID of a platform or instrument.

longitude

numeric vector holding longitude(s).

latitude

numeric vector holding latitude(s).

time

POSIXct vector holding time(s).

server

character value giving the base name of the server, used in the construction of URL queries. Since servers tend to change over time, this is a good argument to check, when debugging code that once worked but now fails.

destdir

character value indicating the directory in which to store downloaded files. The default value of "." means to store the downloaded file in the present working directory. Set destdir=NULL if destfile is a filename with full path information. File clutter is reduced by creating a top-level directory called data, with subdirectories for various file types; see “Examples”.

destfile

character value indicating the name of the file. If not supplied, then the file name is constructed from the other parameters of the function call, so that subsequent calls with the same parameters will yield the same result; this is useful for caching.

force

A logical value that indicates whether to force the download, even if the pathname constructed from destdir and destfile already exists.

dryrun

A logical value that indicates whether to return the constructed web query, without attempting to download the file. This can be helpful in designing responses to changing URLs.

debug

an integer specifying whether debugging information is to be printed during processing. The printing is done by a call to dcDebug(). Setting debug=0 turns off this form of debugging, while higher values yield more information. If one dc function calls another, it passes the value of debug but decreased by 1, which means that the value of debug controls not just the breadth of debugging, but also the depth.

See Also

Other functions related to argo data: dc.argoById(), dc.argoIndex(), dc.argo()


dankelley/dc documentation built on June 3, 2020, 8:25 a.m.