download_npgo: Download North Pacific Gyre Oscillation data

View source: R/download-npgo.R

download_npgoR Documentation

Download North Pacific Gyre Oscillation data

Description

North Pacific Gyre Oscillation data also known as the Victoria mode

Usage

download_npgo(use_cache = FALSE, file = NULL)

Arguments

use_cache

logical option to save and load from cache. If 'TRUE', results will be cached in memory if 'file' is 'NULL' or on disk if 'file' is not 'NULL'.

file

optional character with the full path of a file to save the data. If 'cache' is 'FALSE' but 'file' is not 'NULL', the results will be downloaded from the internet and saved on disk.

Value

  • Date: Date object that uses the first of the month as a placeholder. Date formatted as date on the first of the month because R only supports one partial of date time

  • Year: Year of Record

  • Month: Month of record

  • NPGO: North Pacific Gyre Oscillation

References

http://www.oces.us/npgo/

Examples

## Not run: 
npgo <- download_npgo()

## End(Not run)


boshek/rsoi documentation built on Nov. 3, 2023, 3:30 a.m.