From 79ab6449be8a6fa26fcf1e334a32c359e724b441 Mon Sep 17 00:00:00 2001 From: Nicolau Manubens Date: Thu, 11 Apr 2019 13:50:57 +0200 Subject: [PATCH] Fixes in documentation. --- R/sample_data.R | 10 +++++----- man/areave_data.Rd | 4 ++-- man/lonlat_data.Rd | 4 ++-- man/lonlat_prec.Rd | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/R/sample_data.R b/R/sample_data.R index 87ce3d0e..3a59ec1b 100644 --- a/R/sample_data.R +++ b/R/sample_data.R @@ -3,13 +3,13 @@ #' This sample data set contains gridded seasonal forecast and corresponding observational data from the Copernicus Climate Change ECMWF-System 5 forecast system, and from the Copernicus Climate Change ERA-5 reconstruction. Specifically, for the 'tas' (2-meter temperature) variable, for the 15 first forecast ensemble members, monthly averaged, for the 3 first forecast time steps (lead months 1 to 4) of the November start dates of 2000 to 2005, for the Mediterranean region (27N-48N, 12W-40E). The data was generated on (or interpolated onto, for the reconstruction) a rectangular regular grid of size 360 by 181. #' #' It is recommended to use the data set as follows: -#'\code{ +#'\preformatted{ #' require(zeallot) #' c(exp, obs) %<-% CSTools::lonlat_data #'} #' #' The `CST_Load` call used to generate the data set in the infrastructure of the Earth Sciences Department of the Barcelona Supercomputing Center is shown next. Note that `CST_Load` internally calls `s2dverification::Load`, which would require a configuration file (not provided here) expressing the distribution of the 'system5c3s' and 'era5' NetCDF files in the file system. -#'\code{ +#'\preformatted{ #' library(CSTools) #' require(zeallot) #' @@ -43,7 +43,7 @@ NULL #' #' The `CST_Load` call used to generate the data set in the infrastructure of the Marconi machine at CINECA is shown next, working on files which were extracted from forecast data available in the MEDSCOPE internal archive. #' -#'\code{ +#'\preformatted{ #' library(CSTools) #' #' infile <- list(path = '../medscope/nwalps/data/$VAR_NAME$_$START_DATE$_nwalps.nc') @@ -69,13 +69,13 @@ NULL #' This sample data set contains area-averaged seasonal forecast and corresponding observational data from the Copernicus Climate Change ECMWF-System 5 forecast system, and from the Copernicus Climate Change ERA-5 reconstruction. Specifically, for the 'tas' (2-meter temperature) variable, for the 15 first forecast ensemble members, monthly averaged, for the 3 first forecast time steps (lead months 1 to 4) of the November start dates of 2000 to 2005, for the Mediterranean region (27N-48N, 12W-40E). #' #' It is recommended to use the data set as follows: -#'\code{ +#'\preformatted{ #' require(zeallot) #' c(exp, obs) %<-% CSTools::areave_data #'} #' #' The `CST_Load` call used to generate the data set in the infrastructure of the Earth Sciences Department of the Barcelona Supercomputing Center is shown next. Note that `CST_Load` internally calls `s2dverification::Load`, which would require a configuration file (not provided here) expressing the distribution of the 'system5c3s' and 'era5' NetCDF files in the file system. -#'\code{ +#'\preformatted{ #' library(CSTools) #' require(zeallot) #' diff --git a/man/areave_data.Rd b/man/areave_data.Rd index fd0f5abb..cc79c85c 100644 --- a/man/areave_data.Rd +++ b/man/areave_data.Rd @@ -9,13 +9,13 @@ This sample data set contains area-averaged seasonal forecast and corresponding } \details{ It is recommended to use the data set as follows: -\code{ +\preformatted{ require(zeallot) c(exp, obs) %<-% CSTools::areave_data } The `CST_Load` call used to generate the data set in the infrastructure of the Earth Sciences Department of the Barcelona Supercomputing Center is shown next. Note that `CST_Load` internally calls `s2dverification::Load`, which would require a configuration file (not provided here) expressing the distribution of the 'system5c3s' and 'era5' NetCDF files in the file system. -\code{ +\preformatted{ library(CSTools) require(zeallot) diff --git a/man/lonlat_data.Rd b/man/lonlat_data.Rd index 8d0dbf18..eca7abac 100644 --- a/man/lonlat_data.Rd +++ b/man/lonlat_data.Rd @@ -9,13 +9,13 @@ This sample data set contains gridded seasonal forecast and corresponding observ } \details{ It is recommended to use the data set as follows: -\code{ +\preformatted{ require(zeallot) c(exp, obs) %<-% CSTools::lonlat_data } The `CST_Load` call used to generate the data set in the infrastructure of the Earth Sciences Department of the Barcelona Supercomputing Center is shown next. Note that `CST_Load` internally calls `s2dverification::Load`, which would require a configuration file (not provided here) expressing the distribution of the 'system5c3s' and 'era5' NetCDF files in the file system. -\code{ +\preformatted{ library(CSTools) require(zeallot) diff --git a/man/lonlat_prec.Rd b/man/lonlat_prec.Rd index 23678ead..69cb94e8 100644 --- a/man/lonlat_prec.Rd +++ b/man/lonlat_prec.Rd @@ -10,7 +10,7 @@ This sample data set contains a small cutout of gridded seasonal precipitation f \details{ The `CST_Load` call used to generate the data set in the infrastructure of the Marconi machine at CINECA is shown next, working on files which were extracted from forecast data available in the MEDSCOPE internal archive. -\code{ +\preformatted{ library(CSTools) infile <- list(path = '../medscope/nwalps/data/$VAR_NAME$_$START_DATE$_nwalps.nc') -- GitLab