Newer
Older
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/CST_SaveExp.R
\name{SaveExp}
\alias{SaveExp}
\title{Save an experiment in a format compatible with CST_Load}
\usage{
SaveExp(
data,
Dataset = NULL,
metadata = NULL,
unique_file = FALSE,
extra_string = NULL
\item{data}{An multi-dimensional array with named dimensions (longitude,
latitude, time, member, sdate).}
\item{destination}{A character string indicating the path where to store the
NetCDF files.}
\item{Dates}{A matrix of dates with the corresponding sdate and forecast time
dimension.}
\item{coords}{A named list with elements of the coordinates corresponding to
the dimensions of the data parameter. The names and length of each element
must correspond to the names of the dimensions. If any coordinate is not
provided, it is set as an index vector with the values from 1 to the length
of the corresponding dimension.}
\item{Dataset}{A vector of character string indicating the names of the
datasets.}
\item{varname}{A character string indicating the name of the variable to be
\item{metadata}{A named list where each element is a variable containing the
corresponding information. The information must be contained in a list of
lists for each variable.}
\item{startdates}{A vector of dates indicating the initialization date of each
simulations.}
\item{unique_file}{A logical value indicating if all object is saved in a
unique file (TRUE) or in separated directories (FALSE). When it is FALSE,
the array is separated for dataset, variable and start date.}
\item{extra_string}{A character string to be include as part of the file name,
for instance, to identify member or realization.}
The function creates as many files as sdates per dataset. Each file
could contain multiple members. It would be added to the file name between
underscore characters. The path will be created with the name of the variable
and each Datasets.
This function is created for compatibility with CST_Load/Load for
saving post-processed datasets such as those calibrated of downscaled with
CSTools functions
data <- lonlat_temp$exp$data
lon <- lonlat_temp$exp$coords$lon
lat <- lonlat_temp$exp$coords$lat
coords <- list(lon = lon, lat = lat)
Dataset <- lonlat_temp$exp$attrs$Dataset
varname <- 'tas'
Dates <- lonlat_temp$exp$attrs$Dates
metadata <- lonlat_temp$exp$attrs$Variable$metadata
SaveExp(data = data, destination = destination, coords = coords,
Dataset = Dataset, varname = varname, Dates = Dates,
metadata = metadata, unique_file = TRUE)
\author{
Perez-Zanon Nuria, \email{nuria.perez@bsc.es}
}