read_clim: Reads ocean variables from ESMs
In coruubc/Rcoru: What the Package Does (One Line, Title Case)

View source: R/read_clim.R

read_clim

R Documentation

Reads ocean variables from ESMs

Description

This function reads oceanic climate variables from DROBO. You have to be connected to the UBC network and have access to the CORU-DROBO in order to use the function. Note that no user/id will be required but the path wont be found.

Usage

read_clim(
  cmip = 6,
  esm,
  rcp,
  variable,
  years,
  root_path,
  box = FALSE,
  coords = FALSE,
  repository
)

Arguments

`cmip`	can be 5 for CMIP5 or 6 cmip6. Note that CMPI5 only has GFDL, IPSL and MPI. CMPI6 has additional CNRM and UKESM
`esm`	is the ESM esms to load; GFDL; IPSL, MPI, CNRM, UKESM. For all esms select "All";
`rcp`	expects "26" for RCP 2.6-low emission scenario and "85" for RCP 8.5-high emission scenario
`variable`	expects a variable to be load. Options include: "AdvectionU","AdvectionV", "bot_temp", "htotal_btm", "htotal_surf", "IceExt", "O2_btm","O2_surf","Salinity_btm","Salinity_surf","SST","totalphy2". Note: if you type "options" the function will print all available variables
`years`	expects a sequence of years to load the data from
`box`	Expects a vector with four values in the following order: low lat, high lat, low long and high long to load geographical specific data.. if FALSE it will load global database
`coords`	This is the DBEM/CORU coordinate grid with index, lon and lat
`repository`	If "DROBO" then will expect data tp be in DROBO path, otherwise, inlcude your path here (without root_path)