CST_SaveExp: Save objects of class 's2dv_cube' to data in NetCDF format

In CSTools: Assessing Skill of Climate Forecasts on Seasonal-to-Decadal Timescales

Save objects of class 's2dv_cube' to data in NetCDF format

Description

This function allows to divide and save a object of class 's2dv_cube' into a NetCDF file, allowing to reload the saved data using Start function from StartR package. If the original 's2dv_cube' object has been created from CST_Load(), then it can be reloaded with Load().

Usage

CST_SaveExp(
  data,
  destination = "./",
  sdate_dim = "sdate",
  ftime_dim = "time",
  dat_dim = "dataset",
  var_dim = "var",
  memb_dim = "member",
  startdates = NULL,
  drop_dims = NULL,
  single_file = FALSE,
  extra_string = NULL
)

Arguments

data	An object of class s2dv_cube.
destination	A character string containing the directory name in which to save the data. NetCDF file for each starting date are saved into the folder tree: destination/Dataset/variable/. By default the function creates and saves the data into the working directory.
sdate_dim	A character string indicating the name of the start date dimension. By default, it is set to 'sdate'. It can be NULL if there is no start date dimension.
ftime_dim	A character string indicating the name of the forecast time dimension. By default, it is set to 'time'. It can be NULL if there is no forecast time dimension.
dat_dim	A character string indicating the name of dataset dimension. By default, it is set to 'dataset'. It can be NULL if there is no dataset dimension.
var_dim	A character string indicating the name of variable dimension. By default, it is set to 'var'. It can be NULL if there is no variable dimension.
memb_dim	A character string indicating the name of the member dimension. By default, it is set to 'member'. It can be NULL if there is no member dimension.
startdates	A vector of dates that will be used for the filenames when saving the data in multiple files. It must be a vector of the same length as the start date dimension of data. It must be a vector of class Dates, 'POSIXct' or character with lenghts between 1 and 10. If it is NULL, the coordinate corresponding the the start date dimension or the first Date of each time step will be used as the name of the files. It is NULL by default.
drop_dims	A vector of character strings indicating the dimension names of length 1 that need to be dropped in order that they don't appear in the netCDF file. It is NULL by default (optional).
single_file	A logical value indicating if all object is saved in a single file (TRUE) or in multiple files (FALSE). When it is FALSE, the array is separated for Datasets, variable and start date. It is FALSE by default.
extra_string	A character string to be include as part of the file name, for instance, to identify member or realization. It would be added to the file name between underscore characters.

Value

Multiple or single NetCDF files containing the data array.

single_file = TRUE

All data is saved in a single file located in the specified destination path with the following name: <variable_name>_<extra_string>_<first_sdate>_<last_sdate>.nc. Multiple variables are saved separately in the same file. The forecast time units is extracted from the frequency of the time steps (hours, days, months). The first value of forecast time is 1. If no frequency is found, the units will be 'hours since' each start date and the time steps are assumed to be equally spaced.

single_file = FALSE

The data array is subset and stored into multiple files. Each file contains the data subset for each start date, variable and dataset. Files with different variables and Datasets are stored in separated directories within the following directory tree: destination/Dataset/variable/. The name of each file will be: <variable_name>_<extra_string>_<sdate>.nc.

Author(s)

Perez-Zanon Nuria, [e-mail]

See Also

Start, as.s2dv_cube and s2dv_cube

Examples

## Not run: 
data <- lonlat_temp_st$exp
destination <- "./"
CST_SaveExp(data = data, destination = destination, ftime_dim = 'ftime', 
           var_dim = 'var', dat_dim = 'dataset')

## End(Not run)

CSTools documentation built on Oct. 20, 2023, 5:10 p.m.