read_eddy: Read an eddy file

In SESman/eddies: Global Ocean Eddies Database

Description

Read an eddy file

Usage

read_eddy(x, use.rds = TRUE, rds.save = TRUE, overwrite = FALSE)

Arguments

x	filename
use.rds	Should the ".rds" copy be used to speed up the function if it exists ? Otherwise, the original ".mat" (matlab) file will be used.
rds.save	Should a ".rds" copy of x be saved for a faster access to data later on ?
overwrite	Should the "rds" file be overwritten if it already exists ?

Details

The function uses the path provided by options("eddies.area") to subset a geographical region of focus. This behavior can be turned off by setting this option to NULL

Examples

## Not run: 
edd <- read_eddy("F:/data/eddies/2010/anticyc_20100101.mat")

## End(Not run)

SESman/eddies documentation built on May 9, 2019, 11:10 a.m.