Sort {startR}

Sort the coordinate variable values in a Start() call

Description

The reorder function intended for use as parameter '<dim_name>_reorder' in a call to the function Start(). This function complies with the input/output interface required by Start() defined in the documentation for the parameter ... of that function.

The coordinate applied to Sort() consists of an increasing or decreasing sort of the values. It is useful for adjusting the latitude order.

The coordinate applied to CircularSort() consists of a circular sort of values, where any values beyond the limits specified in the parameters 'start' and 'end' is applied a modulus to fall in the specified range. This is useful for circular coordinates such as the Earth longitudes.

Usage

Sort(...)

CircularSort(start, end, ...)

Arguments

...

Additional parameters to adjust the reorderig. See function sort() for more details.

start

A numeric indicating the lower bound of the circular range.

end

A numeric indicating the upper bound of the circular range.

Value

A list of 2 containing:

$x

The reordered values.

$ix

The permutation indices of $x in the original coordinate.

Examples

# Used in Start():
 data_path <- system.file('extdata', package = 'startR')
 path_obs <- file.path(data_path, 'obs/monthly_mean/$var$/$var$_$sdate$.nc')
 sdates <- c('200011', '200012')
 data <- Start(dat = list(list(path = path_obs)),
               var = 'tos',
               sdate = sdates,
               time = 'all',
               latitude = values(list(-60, 60)),
               latitude_reorder = Sort(decreasing = TRUE),
               longitude = values(list(-120, 120)),
               longitude_reorder = CircularSort(-180, 180),
               return_vars = list(latitude = 'dat',
                                  longitude = 'dat',
                                  time = 'sdate'),
               retrieve = FALSE)