R/family-compc.R

## This file was created automatically, do not edit by hand.
#' Comparison of a field with a constant
#'
#' This module compares all fields of a dataset with a constant. The resulting field is a mask containing 1 if the comparison is true and 0 if not. The type of comparison depends on the chosen operator. 
#'
#' @details
#'     eqc  Equal constant
#'                    /   1   if i(t,x) EQ c     AND  i(t,x),c NE miss
#'          o(t,x) = <    0   if i(t,x) NE c     AND  i(t,x),c NE miss
#'                    \\  miss if i(t,x) EQ miss  OR   c EQ miss
#'     nec  Not equal constant
#'                    /   1   if i(t,x) NE c     AND  i(t,x),c NE miss
#'          o(t,x) = <    0   if i(t,x) EQ c     AND  i(t,x),c NE miss
#'                    \\  miss if i(t,x) EQ miss  OR   c EQ miss
#'     lec  Less equal constant
#'                    /   1   if i(t,x) LE c     AND  i(t,x),c NE miss
#'          o(t,x) = <    0   if i(t,x) GT c     AND  i(t,x),c NE miss
#'                    \\  miss if i(t,x) EQ miss  OR   c EQ miss
#'     ltc  Less than constant
#'                    /   1   if i(t,x) LT c     AND  i(t,x),c NE miss
#'          o(t,x) = <    0   if i(t,x) GE c     AND  i(t,x),c NE miss
#'                    \\  miss if i(t,x) EQ miss  OR   c EQ miss
#'     gec  Greater equal constant
#'                    /   1   if i(t,x) GE c     AND  i(t,x),c NE miss
#'          o(t,x) = <    0   if i(t,x) LT c     AND  i(t,x),c NE miss
#'                    \\  miss if i(t,x) EQ miss  OR   c EQ miss
#'     gtc  Greater than constant
#'                    /   1   if i(t,x) GT c     AND  i(t,x),c NE miss
#'          o(t,x) = <    0   if i(t,x) LE c     AND  i(t,x),c NE miss
#'                    \\  miss if i(t,x) EQ miss  OR   c EQ miss
#' 
#'
#' 
#'
#' @returns
#' Operators that output one or more files return a character vector to the
#' output files.
#'
#' Operators that output an indefinite number of files return a string with the
#' basename of the files.
#'
#' Operatos that don't return filenames return a character vector with the
#' string output.
#' @name compc
NULL

Try the rcdo package in your browser

Any scripts or data that you put into this service are public.

rcdo documentation built on June 8, 2025, 12:36 p.m.