Newer
Older
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/as.s2dv_cube.R
\name{as.s2dv_cube}
\alias{as.s2dv_cube}
\title{Convert seasonal to decadal data to a 's2dv_cube' class}
\usage{
as.s2dv_cube(data, lon = NULL, lat = NULL, Variable = NULL,
Datasets = NULL, Dates = NULL, when = NULL, source_files = NULL)
}
\arguments{
\item{data}{an array with any number of named dimensions, tipically and object output from CST_Load,with the following dimensions: dataset, member, sdate, ftime, lat and lon.}
\item{lon}{an array with one dimension containing the longitudes and attributes: dim, cdo_grid_name, data_across_gw, array_across_gw, first_lon, last_lon and projection.}
\item{lat}{an array with one dimension containing the longitudes and attributes: dim, cdo_grid_name, first_lat, last_lat and projection.}
\item{Variable}{a list of two elements: \code{varName} a character string indicating the abbreviation of a variable name and \code{level} a character string indicating the level, if it is not required it could be set as NULL.}
\item{Datasets}{a named list with the dataset model with two elements: \code{InitiatlizationDates}, containing a list of the start dates for each member named with the names of each member, and \code{Members} containing a vertor with the member names (i.e.: "Member_1")}
\item{Dates}{a named list of two elements: \code{start}, an array of dimensions (sdate, time) with the POSIX initial date of each forecast time of each starting date, and \code{end}, an array of dimensions (sdate, time) with the POSIX final date of each forecast time of each starting date.}
\item{when}{a time stamp of the date the Load() call to obtain the data was issued.}
\item{source_files}{a vector of character strings with complete paths to all the found files involved in the Load() call.}
}
\value{
a object of class 's2dv_cube'.
}
\description{
This function allows to convert data to 's2dv_cube' class if the data hasn't been loaded using CST_Load or has been transformed with other methods. A 's2dv_cube' object has many different components including metadata. This function will allow to create partial 's2dv_cube' objects and for each expected missed parameter a warning message will be displayed.
}
\examples{
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
exp_original <- 1:100
dim(exp_original) <- c(lat = 2, time = 10, lon = 5)
exp1 <- as.s2dv_cube(data = exp_original)
class(exp1)
exp2 <- as.s2dv_cube(data = exp_original, lon = seq(-10, 10, 5), lat = c(45, 50))
class(exp2)
exp3 <- as.s2dv_cube(data = exp_original, lon = seq(-10, 10, 5), lat = c(45, 50),
Variable = list(varName = 'tas', level = '2m'))
class(exp3)
exp4 <- as.s2dv_cube(data = exp_original, lon = seq(-10, 10, 5), lat = c(45, 50),
Variable = list(varName = 'tas', level = '2m'),
Dates = list(start = paste0(rep("01", 10), rep("01", 10), 1990:1999),
end = paste0(rep("31", 10), rep("01", 10), 1990:1999)))
class(exp4)
exp5 <- as.s2dv_cube(data = exp_original, lon = seq(-10, 10, 5), lat = c(45, 50),
Variable = list(varName = 'tas', level = '2m'),
Dates = list(start = paste0(rep("01", 10), rep("01", 10), 1990:1999),
end = paste0(rep("31", 10), rep("01", 10), 1990:1999)),
when = "2019-10-23 19:15:29 CET")
class(exp5)
exp6 <- as.s2dv_cube(data = exp_original, lon = seq(-10, 10, 5), lat = c(45, 50),
Variable = list(varName = 'tas', level = '2m'),
Dates = list(start = paste0(rep("01", 10), rep("01", 10), 1990:1999),
end = paste0(rep("31", 10), rep("01", 10), 1990:1999)),
when = "2019-10-23 19:15:29 CET",
source_files = c("/path/to/file1.nc", "/path/to/file2.nc"))
class(exp6)
exp7 <- as.s2dv_cube(data = exp_original, lon = seq(-10, 10, 5), lat = c(45, 50),
Variable = list(varName = 'tas', level = '2m'),
Dates = list(start = paste0(rep("01", 10), rep("01", 10), 1990:1999),
end = paste0(rep("31", 10), rep("01", 10), 1990:1999)),
when = "2019-10-23 19:15:29 CET",
source_files = c("/path/to/file1.nc", "/path/to/file2.nc"),
Datasets = list(
exp1 = list(InitializationsDates = list(Member_1 = "01011990",
Members = "Member_1"))))
class(exp7)
dim(exp_original) <- c(dataset = 1, member = 1, sdate = 2, ftime = 5, lat = 2, lon = 5)
exp8 <- as.s2dv_cube(data = exp_original, lon = seq(-10, 10, 5), lat = c(45, 50),
Variable = list(varName = 'tas', level = '2m'),
Dates = list(start = paste0(rep("01", 10), rep("01", 10), 1990:1999),
end = paste0(rep("31", 10), rep("01", 10), 1990:1999)))
class(exp8)