From e4fefe8aded0f00e93cf2c39ddadce5004e7d48e Mon Sep 17 00:00:00 2001 From: jbedia Date: Sat, 27 Dec 2014 18:56:33 +0100 Subject: [PATCH] Doc update --- NAMESPACE | 4 ++-- man/aggr6hToDailyMean.Rd | 2 +- man/analogs.Rd | 11 +++++++++-- man/array3Dto2Dmat.Rd | 2 +- man/biasCorrection.Rd | 8 ++++---- man/bubbleValidation.Rd | 2 +- man/calibrateProj.Rd | 2 +- man/dataInventory.ASCII.Rd | 2 +- man/dataInventory.NetCDF.Rd | 2 +- man/dataInventory.Rd | 2 +- man/dateReplacement.Rd | 2 +- man/deaccum.Rd | 2 +- man/dictionaryLookup.Rd | 2 +- man/dictionaryTransform.Rd | 2 +- man/dictionaryTransformGrid.Rd | 6 +++--- man/fieldFromPCs.Rd | 2 +- man/findPointXYindex.Rd | 2 +- man/findVerticalLevel.Rd | 2 +- man/getCoordinates.Rd | 2 +- man/getGrid.Rd | 2 +- man/getLatLonDomain.Rd | 2 +- man/getLatLonDomainStations.Rd | 2 +- man/getSeason.Rd | 2 +- man/getTimeDomain.Rd | 2 +- man/getTimeDomainStations.Rd | 2 +- man/getVerticalLevelPars.Rd | 6 +++--- man/getYearsAsINDEX.Rd | 2 +- man/glimpr.Rd | 2 +- man/hurs2huss.Rd | 2 +- man/iberia_ncep_hus850.Rd | 2 +- man/iberia_ncep_psl.Rd | 2 +- man/iberia_ncep_ta850.Rd | 2 +- man/interpGridData.Rd | 2 +- man/isimip.Rd | 2 +- man/loadGridData.Rd | 14 +++++++------- man/loadGridDataset.Rd | 2 +- man/loadMultiField.Rd | 2 +- man/loadStationData.ASCII.Rd | 2 +- man/loadStationData.Rd | 12 ++++++------ man/{login_SMG.Rd => login_TAP.Rd} | 10 +++++----- man/makeAggregatedDataset.Rd | 2 +- man/makeMultiField.Rd | 2 +- man/makeSubset.Rd | 6 +++--- man/mat2Dto3Darray.Rd | 2 +- man/mslp2ps.Rd | 2 +- man/multiPlot.Rd | 2 +- man/plotEOF.Rd | 8 ++++---- man/plotMeanField.Rd | 2 +- man/ppModelSetup.Rd | 2 +- man/prinComp.Rd | 2 +- man/renameDims.Rd | 2 +- man/revArrayLatDim.Rd | 6 +++--- man/scanVarDimensions.Rd | 2 +- man/stationInfo.Rd | 2 +- man/tasmax_forecast.Rd | 2 +- man/tasmin_forecast.Rd | 2 +- man/tdps2hurs.Rd | 2 +- man/tercileValidation.Rd | 2 +- man/timeBounds.Rd | 2 +- man/toDD.Rd | 2 +- man/tp_forecast.Rd | 2 +- man/vocabulary.Rd | 2 +- 62 files changed, 100 insertions(+), 93 deletions(-) rename man/{login_SMG.Rd => login_TAP.Rd} (87%) diff --git a/NAMESPACE b/NAMESPACE index c486da81..7e94cb39 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1,4 +1,4 @@ -# Generated by roxygen2 (4.0.1): do not edit by hand +# Generated by roxygen2 (4.0.2): do not edit by hand export(aggr6hToDailyMean) export(analogs) @@ -25,7 +25,7 @@ export(isimip) export(loadGridData) export(loadMultiField) export(loadStationData) -export(login_SMG) +export(login_TAP) export(makeAggregatedDataset) export(makeMultiField) export(makeSubset) diff --git a/man/aggr6hToDailyMean.Rd b/man/aggr6hToDailyMean.Rd index d062e98b..7ce9055f 100644 --- a/man/aggr6hToDailyMean.Rd +++ b/man/aggr6hToDailyMean.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{aggr6hToDailyMean} \alias{aggr6hToDailyMean} \title{Performs the aggregation of 6 hourly data to daily mean} diff --git a/man/analogs.Rd b/man/analogs.Rd index 30b75c11..329db028 100644 --- a/man/analogs.Rd +++ b/man/analogs.Rd @@ -1,9 +1,10 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{analogs} \alias{analogs} \title{Analog downscaling} \usage{ -analogs(obs, pred, sim, n.neigh = 1, sel.fun = c("random", "mean")) +analogs(obs, pred, sim, n.neigh = 1, sel.fun = c("random", "mean"), + analog.dates = FALSE) } \arguments{ \item{obs}{A field or station data containing the observed climate data for the training period} @@ -19,6 +20,12 @@ the same variable as \code{obs}, in the case of model calibration (bias correcti \item{sel.fun}{Criterion for the construction of analogs when several neigbours are chosen. Ignored when \code{n.neig = 1}. Current values are \code{"random"} (the default) and \code{"mean"}. See details.} + +\item{analog.dates}{Logical flag indicating whether the dates of the analogs should be returned. If set to TRUE, + the analog dates will be returned as a global attribute named \code{"analog.dates"}. The analog + dates can be only returned for one single neighbour selections (argument \code{n.neigh = 1}), + otherwise it will give an error. Note that the analog dates are different for each member in case of + multimember downscaling, and are returned as a list, each element of the list corresponding to one member.} } \description{ Implementation of the downscaling analogs method diff --git a/man/array3Dto2Dmat.Rd b/man/array3Dto2Dmat.Rd index 2d8ec23b..f8b1cea6 100644 --- a/man/array3Dto2Dmat.Rd +++ b/man/array3Dto2Dmat.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{array3Dto2Dmat} \alias{array3Dto2Dmat} \title{Conversion of a 3D array to a 2D matrix} diff --git a/man/biasCorrection.Rd b/man/biasCorrection.Rd index 9cf19032..79bb6e1c 100644 --- a/man/biasCorrection.Rd +++ b/man/biasCorrection.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{biasCorrection} \alias{biasCorrection} \title{Bias correction methods} @@ -19,11 +19,11 @@ the same variable as \code{obs}, in the case of model calibration (bias correcti \item{method}{method applied. Current accepted values are \code{"qqmap"}, \code{"delta"}, \code{"scaling"}, \code{"unbiasing"} and \code{"piani"}. See details.} -\item{multi.member}{Should members be adjusted sepparately (TRUE, default), or jointly (FALSE)?. -Ignored if the dataset has no members.} - \item{pr.threshold}{The minimum value that is considered as a non-zero precipitation. Ignored for \code{varcode} values different from \code{"pr"}. Default to 1 (assuming mm).} + +\item{multi.member}{Should members be adjusted sepparately (TRUE, default), or jointly (FALSE)?. +Ignored if the dataset has no members.} } \value{ A calibrated object of the same spatio-temporal extent of the input field diff --git a/man/bubbleValidation.Rd b/man/bubbleValidation.Rd index a4fb7ecc..35bfacb6 100644 --- a/man/bubbleValidation.Rd +++ b/man/bubbleValidation.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{bubbleValidation} \alias{bubbleValidation} \title{Bubble plot for visualization of the skill of an ensemble forecast prediction} diff --git a/man/calibrateProj.Rd b/man/calibrateProj.Rd index a48dc173..f23d640d 100644 --- a/man/calibrateProj.Rd +++ b/man/calibrateProj.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{calibrateProj} \alias{calibrateProj} \title{Bias correction methods} diff --git a/man/dataInventory.ASCII.Rd b/man/dataInventory.ASCII.Rd index cb87d540..9b6575f2 100644 --- a/man/dataInventory.ASCII.Rd +++ b/man/dataInventory.ASCII.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{dataInventory.ASCII} \alias{dataInventory.ASCII} \title{Data inventory of standard ASCII station datasets} diff --git a/man/dataInventory.NetCDF.Rd b/man/dataInventory.NetCDF.Rd index ef709720..aae7eefd 100644 --- a/man/dataInventory.NetCDF.Rd +++ b/man/dataInventory.NetCDF.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{dataInventory.NetCDF} \alias{dataInventory.NetCDF} \title{Inventory of a gridded dataset} diff --git a/man/dataInventory.Rd b/man/dataInventory.Rd index e9d5d3d8..ec54c0ef 100644 --- a/man/dataInventory.Rd +++ b/man/dataInventory.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{dataInventory} \alias{dataInventory} \title{Dataset inventory} diff --git a/man/dateReplacement.Rd b/man/dateReplacement.Rd index dcb62189..345e9553 100644 --- a/man/dateReplacement.Rd +++ b/man/dateReplacement.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{dateReplacement} \alias{dateReplacement} \title{Compute dates of a downscaled observational dataset} diff --git a/man/deaccum.Rd b/man/deaccum.Rd index 44969de7..cadc806d 100644 --- a/man/deaccum.Rd +++ b/man/deaccum.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{deaccum} \alias{deaccum} \title{Performs deaccumulation} diff --git a/man/dictionaryLookup.Rd b/man/dictionaryLookup.Rd index 9f5d4baa..4b5bc78f 100644 --- a/man/dictionaryLookup.Rd +++ b/man/dictionaryLookup.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{dictionaryLookup} \alias{dictionaryLookup} \title{Searches variable string in the dictionary} diff --git a/man/dictionaryTransform.Rd b/man/dictionaryTransform.Rd index e8d6a2e0..1b0cd094 100644 --- a/man/dictionaryTransform.Rd +++ b/man/dictionaryTransform.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{dictionaryTransform} \alias{dictionaryTransform} \title{Performs variable transformation} diff --git a/man/dictionaryTransformGrid.Rd b/man/dictionaryTransformGrid.Rd index 26a75b85..249db588 100644 --- a/man/dictionaryTransformGrid.Rd +++ b/man/dictionaryTransformGrid.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{dictionaryTransformGrid} \alias{dictionaryTransformGrid} \title{Performs variable transformation} @@ -8,9 +8,9 @@ dictionaryTransformGrid(dic, timePars, mdArray) \arguments{ \item{dic}{Dictionary line for the variable, as returned by \code{dictionaryLookup} or \code{dictionaryLookup.ECOMS}} -\item{foreTimePars}{A list of time selection parameters, as returned by \code{getTimeDomain}} - \item{mdArray}{A n-dimensional array, as returned by \code{makeSubset}} + +\item{foreTimePars}{A list of time selection parameters, as returned by \code{getTimeDomain}} } \value{ The transformed n dimensional array of data. See details. diff --git a/man/fieldFromPCs.Rd b/man/fieldFromPCs.Rd index 65a65c14..40cf3fcb 100644 --- a/man/fieldFromPCs.Rd +++ b/man/fieldFromPCs.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{fieldFromPCs} \alias{fieldFromPCs} \title{Reconstruct a Field from EOFs and principal components} diff --git a/man/findPointXYindex.Rd b/man/findPointXYindex.Rd index e8529562..959c6f9d 100644 --- a/man/findPointXYindex.Rd +++ b/man/findPointXYindex.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{findPointXYindex} \alias{findPointXYindex} \title{Define user-defined geolocation parameters} diff --git a/man/findVerticalLevel.Rd b/man/findVerticalLevel.Rd index e39da9be..f6628f92 100644 --- a/man/findVerticalLevel.Rd +++ b/man/findVerticalLevel.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{findVerticalLevel} \alias{findVerticalLevel} \title{Finds vertical level from variable definition} diff --git a/man/getCoordinates.Rd b/man/getCoordinates.Rd index e2b1f2b6..19ae147e 100644 --- a/man/getCoordinates.Rd +++ b/man/getCoordinates.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{getCoordinates} \alias{getCoordinates} \title{Get geographical coordinates of a climate data object} diff --git a/man/getGrid.Rd b/man/getGrid.Rd index cc4a0ae3..9a08eeea 100644 --- a/man/getGrid.Rd +++ b/man/getGrid.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{getGrid} \alias{getGrid} \title{Get regular grid definition} diff --git a/man/getLatLonDomain.Rd b/man/getLatLonDomain.Rd index 8bf79bfa..ab382192 100644 --- a/man/getLatLonDomain.Rd +++ b/man/getLatLonDomain.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{getLatLonDomain} \alias{getLatLonDomain} \title{Determine the geo-location parameters of an arbitrary user selection} diff --git a/man/getLatLonDomainStations.Rd b/man/getLatLonDomainStations.Rd index d31ac107..66129a3f 100644 --- a/man/getLatLonDomainStations.Rd +++ b/man/getLatLonDomainStations.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{getLatLonDomainStations} \alias{getLatLonDomainStations} \title{Define geolocation of station datasets} diff --git a/man/getSeason.Rd b/man/getSeason.Rd index d524793d..c2c5445f 100644 --- a/man/getSeason.Rd +++ b/man/getSeason.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{getSeason} \alias{getSeason} \title{Get season from a station or field object} diff --git a/man/getTimeDomain.Rd b/man/getTimeDomain.Rd index 0bbfd185..b688d674 100644 --- a/man/getTimeDomain.Rd +++ b/man/getTimeDomain.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{getTimeDomain} \alias{getTimeDomain} \title{Selection of time slices of gridded datasets} diff --git a/man/getTimeDomainStations.Rd b/man/getTimeDomainStations.Rd index c58c4cfe..85d4e12e 100644 --- a/man/getTimeDomainStations.Rd +++ b/man/getTimeDomainStations.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{getTimeDomainStations} \alias{getTimeDomainStations} \title{Time index positions for station dataset selections} diff --git a/man/getVerticalLevelPars.Rd b/man/getVerticalLevelPars.Rd index 248b4ca7..7ac38745 100644 --- a/man/getVerticalLevelPars.Rd +++ b/man/getVerticalLevelPars.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{getVerticalLevelPars} \alias{getVerticalLevelPars} \title{Definition of vertical dimension slices} @@ -6,9 +6,9 @@ getVerticalLevelPars(grid, level) } \arguments{ -\item{gcs}{An object of the java class \sQuote{GeoGrid})} - \item{level}{Vertical level. Passed by \code{loadGridDataset}, obtained via \code{findVerticalLevel}} + +\item{gcs}{An object of the java class \sQuote{GeoGrid})} } \value{ A list with the level value and either a java Range or a java null reference diff --git a/man/getYearsAsINDEX.Rd b/man/getYearsAsINDEX.Rd index d6118826..9aec60a1 100644 --- a/man/getYearsAsINDEX.Rd +++ b/man/getYearsAsINDEX.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{getYearsAsINDEX} \alias{getYearsAsINDEX} \title{Get years as a factor} diff --git a/man/glimpr.Rd b/man/glimpr.Rd index 2494214a..7753304c 100644 --- a/man/glimpr.Rd +++ b/man/glimpr.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{glimpr} \alias{glimpr} \title{GLM downscaling} diff --git a/man/hurs2huss.Rd b/man/hurs2huss.Rd index 1ca63b62..5eb05a71 100644 --- a/man/hurs2huss.Rd +++ b/man/hurs2huss.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{hurs2huss} \alias{hurs2huss} \title{Specific humidity from relative humidity} diff --git a/man/iberia_ncep_hus850.Rd b/man/iberia_ncep_hus850.Rd index c5ae60f5..6ecee24b 100644 --- a/man/iberia_ncep_hus850.Rd +++ b/man/iberia_ncep_hus850.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{iberia_ncep_hus850} \alias{iberia_ncep_hus850} \title{Field containing NCEP reanalysis data of specific humidity at 850mb for the Iberian Peninsula.} diff --git a/man/iberia_ncep_psl.Rd b/man/iberia_ncep_psl.Rd index b6abc67b..08fa2a97 100644 --- a/man/iberia_ncep_psl.Rd +++ b/man/iberia_ncep_psl.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{iberia_ncep_psl} \alias{iberia_ncep_psl} \title{Field containing NCEP reanalysis data of sea-level pressure for the Iberian Peninsula.} diff --git a/man/iberia_ncep_ta850.Rd b/man/iberia_ncep_ta850.Rd index 1954effa..1a3372c3 100644 --- a/man/iberia_ncep_ta850.Rd +++ b/man/iberia_ncep_ta850.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{iberia_ncep_ta850} \alias{iberia_ncep_ta850} \title{Field containing NCEP reanalysis data of air temperature at 850mb for the Iberian Peninsula.} diff --git a/man/interpGridData.Rd b/man/interpGridData.Rd index 1632d439..7143c5f1 100644 --- a/man/interpGridData.Rd +++ b/man/interpGridData.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{interpGridData} \alias{interpGridData} \title{Interpolate a dataset to a grid} diff --git a/man/isimip.Rd b/man/isimip.Rd index d5d5a4b8..b0ea691d 100644 --- a/man/isimip.Rd +++ b/man/isimip.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{isimip} \alias{isimip} \title{Bias correction ISI-MIP method} diff --git a/man/loadGridData.Rd b/man/loadGridData.Rd index 2ab34b08..f3a8fe00 100644 --- a/man/loadGridData.Rd +++ b/man/loadGridData.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{loadGridData} \alias{loadGridData} \title{Load a field from a dataset} @@ -16,6 +16,12 @@ this is the path to the directory the dataset lives in.} by the \dQuote{@} symbol (e.g. \code{var = "z@700"} for geopotential heigth at 700 mb isobaric surface pressure level). It is also possible to enter the variable name as originally coded in the dataset to skip data homogenization.} +\item{dictionary}{Default to TRUE, indicating that a dictionary is used and the .dic file is stored in the same path than the +dataset. If the .dic file is stored elsewhere, then the argument is the full path to the .dic file (including the extension, +e.g.: \code{"/path/to/the/dictionary_file.dic"}). This is the case for instance when the dataset is stored in a remote URL, +and we have a locally stored dictionary for that particular dataset. If FALSE no variable homogenization takes place, +and the raw variable, as originally stored in the dataset, will be returned. See details for dictionary specification.} + \item{lonLim}{Vector of length = 2, with minimum and maximum longitude coordinates, in decimal degrees, of the bounding box selected. For single-point queries, a numeric value with the longitude coordinate. If \code{NULL} (default), the whole longitudinal range is selected (Note that this may lead to a large output object size).} @@ -28,12 +34,6 @@ Options include one to several (contiguous) months. Default to \code{NULL}, indi \item{years}{Optional vector of years to select. Default (\code{NULL}) to all available years. If the requested variable is static (e.g. orography) it will be ignored.} -\item{dictionary}{Default to TRUE, indicating that a dictionary is used and the .dic file is stored in the same path than the -dataset. If the .dic file is stored elsewhere, then the argument is the full path to the .dic file (including the extension, -e.g.: \code{"/path/to/the/dictionary_file.dic"}). This is the case for instance when the dataset is stored in a remote URL, -and we have a locally stored dictionary for that particular dataset. If FALSE no variable homogenization takes place, -and the raw variable, as originally stored in the dataset, will be returned. See details for dictionary specification.} - \item{time}{A character vector indicating the temporal filtering/aggregation of the output data. Default to \code{"none"}, which returns the original time series as stored in the dataset. For sub-daily variables, instantantaneous data at diff --git a/man/loadGridDataset.Rd b/man/loadGridDataset.Rd index 427d212d..40244662 100644 --- a/man/loadGridDataset.Rd +++ b/man/loadGridDataset.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{loadGridDataset} \alias{loadGridDataset} \title{Loads a user-defined subset of a gridded CDM dataset} diff --git a/man/loadMultiField.Rd b/man/loadMultiField.Rd index 732b5d6c..f49c648a 100644 --- a/man/loadMultiField.Rd +++ b/man/loadMultiField.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{loadMultiField} \alias{loadMultiField} \title{Load several gridded variables} diff --git a/man/loadStationData.ASCII.Rd b/man/loadStationData.ASCII.Rd index 87b4d179..04730c5b 100644 --- a/man/loadStationData.ASCII.Rd +++ b/man/loadStationData.ASCII.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{loadStationData.ASCII} \alias{loadStationData.ASCII} \title{Load station data in standard ASCII format} diff --git a/man/loadStationData.Rd b/man/loadStationData.Rd index d7e25809..40a0a5ac 100644 --- a/man/loadStationData.Rd +++ b/man/loadStationData.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{loadStationData} \alias{loadStationData} \title{Load station data} @@ -11,11 +11,16 @@ loadStationData(dataset, file.format = "ascii", var, stationID = NULL, pointing to a netCDF or NcML file in the case of netCDF and/or gridded datasets. For station data in standard ASCII format, this is the path to the directory the dataset lives in.} +\item{file.format}{Wether the stations data are stored in a netCDF or ASCII (default) file. +Currently only the standard \dQuote{ASCII} format supported. See references for details.} + \item{var}{Variable code (character string). This is the name of the variable according to the R standard naming (see the next argument). For variables with vertical levels, the vertical level is specified next to the variable name followed by the \dQuote{@} symbol (e.g. \code{var = "z@700"} for geopotential heigth at 700 mb isobaric surface pressure level). It is also possible to enter the variable name as originally coded in the dataset to skip data homogenization.} +\item{stationID}{Optional. A character vector indicating the code names of the stations to be loaded.} + \item{lonLim}{Vector of length = 2, with minimum and maximum longitude coordinates, in decimal degrees, of the bounding box selected. For single-point queries, a numeric value with the longitude coordinate. If \code{NULL} (default), the whole longitudinal range is selected (Note that this may lead to a large output object size).} @@ -28,11 +33,6 @@ Options include one to several (contiguous) months. Default to \code{NULL}, indi \item{years}{Optional vector of years to select. Default (\code{NULL}) to all available years. If the requested variable is static (e.g. orography) it will be ignored.} -\item{file.format}{Wether the stations data are stored in a netCDF or ASCII (default) file. -Currently only the standard \dQuote{ASCII} format supported. See references for details.} - -\item{stationID}{Optional. A character vector indicating the code names of the stations to be loaded.} - \item{tz}{A time zone specification to be used for the conversion of dates, if one is required (i.e., if the time zone of the dataset does not correspond to the system-specific one; see \code{\link[base]{timezones}} for details). Default to unspecified (i.e. \code{tz = ""}).} diff --git a/man/login_SMG.Rd b/man/login_TAP.Rd similarity index 87% rename from man/login_SMG.Rd rename to man/login_TAP.Rd index 36690402..cbe83bf4 100644 --- a/man/login_SMG.Rd +++ b/man/login_TAP.Rd @@ -1,9 +1,9 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand -\name{login_SMG} -\alias{login_SMG} -\title{Login to the Santander Met Group Data Server} +% Generated by roxygen2 (4.0.2): do not edit by hand +\name{login_TAP} +\alias{login_TAP} +\title{Login to the Santander Met Group Thredds Data Server} \usage{ -login_SMG(username, password, proxy.host = NULL, proxy.port = NULL) +login_TAP(username, password, proxy.host = NULL, proxy.port = NULL) } \arguments{ \item{username}{A character string with a valid user ID. See details.} diff --git a/man/makeAggregatedDataset.Rd b/man/makeAggregatedDataset.Rd index d8060a59..239a73b0 100644 --- a/man/makeAggregatedDataset.Rd +++ b/man/makeAggregatedDataset.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{makeAggregatedDataset} \alias{makeAggregatedDataset} \title{Create a dataset from a collection of (netCDF) files} diff --git a/man/makeMultiField.Rd b/man/makeMultiField.Rd index 998ccc84..5848d804 100644 --- a/man/makeMultiField.Rd +++ b/man/makeMultiField.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{makeMultiField} \alias{makeMultiField} \title{Constructor of a multifield from various fields, supporting multimember fields.} diff --git a/man/makeSubset.Rd b/man/makeSubset.Rd index c3e0e784..32b79d0b 100644 --- a/man/makeSubset.Rd +++ b/man/makeSubset.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{makeSubset} \alias{makeSubset} \title{Reads an arbitrary data slice} @@ -6,8 +6,6 @@ makeSubset(grid, timePars, zRange, latLon) } \arguments{ -\item{A}{grid of the java class \sQuote{ucar.nc2.dt.grid.GeoGrid}} - \item{timePars}{A list of time parameters as returnde by \code{getTimeDomain}.} \item{zRange}{A \sQuote{ucar.ma2.Range} or a null reference, as returned by @@ -15,6 +13,8 @@ makeSubset(grid, timePars, zRange, latLon) \item{latLon}{A list of geospatial parameters, as returned by \code{getLatLonDomain}.} + +\item{A}{grid of the java class \sQuote{ucar.nc2.dt.grid.GeoGrid}} } \value{ A n-dimensional array with the selected subset data. diff --git a/man/mat2Dto3Darray.Rd b/man/mat2Dto3Darray.Rd index cb5b11eb..89b97c55 100644 --- a/man/mat2Dto3Darray.Rd +++ b/man/mat2Dto3Darray.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{mat2Dto3Darray} \alias{mat2Dto3Darray} \title{Conversion 2D matrix into a 3D array} diff --git a/man/mslp2ps.Rd b/man/mslp2ps.Rd index 413f7b68..e2117a4a 100644 --- a/man/mslp2ps.Rd +++ b/man/mslp2ps.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{mslp2ps} \alias{mslp2ps} \title{Sea-level pressure to surface pressure} diff --git a/man/multiPlot.Rd b/man/multiPlot.Rd index aaaaec44..fbc8e52c 100644 --- a/man/multiPlot.Rd +++ b/man/multiPlot.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{multiPlot} \alias{multiPlot} \title{Make multi-panel plots} diff --git a/man/plotEOF.Rd b/man/plotEOF.Rd index eee86545..5170cfd2 100644 --- a/man/plotEOF.Rd +++ b/man/plotEOF.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{plotEOF} \alias{plotEOF} \title{Plot an arbitrary number of EOFs} @@ -11,11 +11,11 @@ plotEOF(prinCompObj, var = NULL, member = 1, n.eofs = NULL) \item{var}{Character string indicating the variable whose EOFs are to be displayed. If the PCA analysis has been applied to 1 single field, this argument can be omitted.} -\item{n.eofs}{Number of EOFs to be displayed. Default to NULL, indicating that all computed EOFS -will be represented} - \item{member}{An integer indicating the position of the member whose EOFs are to be displayed. Default 1, corresponding to the first member. Ignored for non multimember fields.} + +\item{n.eofs}{Number of EOFs to be displayed. Default to NULL, indicating that all computed EOFS +will be represented} } \value{ A plot with as many panels as EOFs requested, in the original units of the variable diff --git a/man/plotMeanField.Rd b/man/plotMeanField.Rd index 5991f30e..4d9cfca5 100644 --- a/man/plotMeanField.Rd +++ b/man/plotMeanField.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{plotMeanField} \alias{plotMeanField} \title{Plot a map of the mean value of a grid dataset} diff --git a/man/ppModelSetup.Rd b/man/ppModelSetup.Rd index 6adfc0d7..552be769 100644 --- a/man/ppModelSetup.Rd +++ b/man/ppModelSetup.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{ppModelSetup} \alias{ppModelSetup} \title{Data preparation for perfect-prog model construction} diff --git a/man/prinComp.Rd b/man/prinComp.Rd index 7d10c791..d61bbfda 100644 --- a/man/prinComp.Rd +++ b/man/prinComp.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{prinComp} \alias{prinComp} \title{Principal Component Analysis of field/multifield/multimember data} diff --git a/man/renameDims.Rd b/man/renameDims.Rd index cbbfc2be..cafd94bd 100644 --- a/man/renameDims.Rd +++ b/man/renameDims.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{renameDims} \alias{renameDims} \title{Set the 'dimensions' attribute} diff --git a/man/revArrayLatDim.Rd b/man/revArrayLatDim.Rd index a5c47bff..a9eac2e5 100644 --- a/man/revArrayLatDim.Rd +++ b/man/revArrayLatDim.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{revArrayLatDim} \alias{revArrayLatDim} \title{Reverse latitude coordinates ordering} @@ -8,9 +8,9 @@ revArrayLatDim(mdArray, grid) \arguments{ \item{mdArray}{A n-dimensional array of data as returned by \code{makeSubset}} -\item{dimNamesRef}{Character vector with the (ordered) names of the dimensions of the array} - \item{grid}{A java-class \sQuote{GeoGrid}} + +\item{dimNamesRef}{Character vector with the (ordered) names of the dimensions of the array} } \value{ A n-dimensional array with the ordering of the lat dimension reversed diff --git a/man/scanVarDimensions.Rd b/man/scanVarDimensions.Rd index c964091a..76830a8e 100644 --- a/man/scanVarDimensions.Rd +++ b/man/scanVarDimensions.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{scanVarDimensions} \alias{scanVarDimensions} \title{Retrieve dimension information for a gridded variable} diff --git a/man/stationInfo.Rd b/man/stationInfo.Rd index f6549d77..7748e55b 100644 --- a/man/stationInfo.Rd +++ b/man/stationInfo.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{stationInfo} \alias{stationInfo} \title{Retrieve station info} diff --git a/man/tasmax_forecast.Rd b/man/tasmax_forecast.Rd index 6e93594e..7c2d5f3a 100644 --- a/man/tasmax_forecast.Rd +++ b/man/tasmax_forecast.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{tasmax_forecast} \alias{tasmax_forecast} \title{Multimember field containing a seasonal forecast of maximum surface temperature for Europe} diff --git a/man/tasmin_forecast.Rd b/man/tasmin_forecast.Rd index 240d9621..b1a2eb75 100644 --- a/man/tasmin_forecast.Rd +++ b/man/tasmin_forecast.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{tasmin_forecast} \alias{tasmin_forecast} \title{Multimember field containing a seasonal forecast of minimum surface temperature for Europe} diff --git a/man/tdps2hurs.Rd b/man/tdps2hurs.Rd index 5be867cb..39812c0c 100644 --- a/man/tdps2hurs.Rd +++ b/man/tdps2hurs.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{tdps2hurs} \alias{tdps2hurs} \title{Dew point to relative humidity} diff --git a/man/tercileValidation.Rd b/man/tercileValidation.Rd index b852171a..3f936ff2 100644 --- a/man/tercileValidation.Rd +++ b/man/tercileValidation.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{tercileValidation} \alias{tercileValidation} \title{Tercile plot for visualization of the skill of an ensemble forecast prediction} diff --git a/man/timeBounds.Rd b/man/timeBounds.Rd index 5d3cc4d4..d4b0fb43 100644 --- a/man/timeBounds.Rd +++ b/man/timeBounds.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{timeBounds} \alias{timeBounds} \title{Calculate time bounds of a verification time} diff --git a/man/toDD.Rd b/man/toDD.Rd index 5ed95981..dded97d8 100644 --- a/man/toDD.Rd +++ b/man/toDD.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{toDD} \alias{toDD} \title{6-hourly to daily data aggregator} diff --git a/man/tp_forecast.Rd b/man/tp_forecast.Rd index 46bdb922..08b1fa66 100644 --- a/man/tp_forecast.Rd +++ b/man/tp_forecast.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \name{tp_forecast} \alias{tp_forecast} \title{Multimember field containing a seasonal forecast of precipitation for Europe} diff --git a/man/vocabulary.Rd b/man/vocabulary.Rd index 88f16d0f..e58aaf0f 100644 --- a/man/vocabulary.Rd +++ b/man/vocabulary.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.0.1): do not edit by hand +% Generated by roxygen2 (4.0.2): do not edit by hand \docType{data} \name{vocabulary} \alias{vocabulary}