R: Check that an argument is a date/time object in POSIXct...

checkPOSIXct {checkmate} | R Documentation

## Check that an argument is a date/time object in POSIXct format

### Description

Checks that an object is of class `POSIXct`.

### Usage

    checkPOSIXct(
      x,
      lower = NULL,
      upper = NULL,
      any.missing = TRUE,
      all.missing = TRUE,
      len = NULL,
      min.len = NULL,
      max.len = NULL,
      unique = FALSE,
      sorted = FALSE,
      null.ok = FALSE
    )

    check_posixct(
      x,
      lower = NULL,
      upper = NULL,
      any.missing = TRUE,
      all.missing = TRUE,
      len = NULL,
      min.len = NULL,
      max.len = NULL,
      unique = FALSE,
      sorted = FALSE,
      null.ok = FALSE
    )

    assertPOSIXct(
      x,
      lower = NULL,
      upper = NULL,
      any.missing = TRUE,
      all.missing = TRUE,
      len = NULL,
      min.len = NULL,
      max.len = NULL,
      unique = FALSE,
      sorted = FALSE,
      null.ok = FALSE,
      .var.name = vname(x),
      add = NULL
    )

    assert_posixct(
      x,
      lower = NULL,
      upper = NULL,
      any.missing = TRUE,
      all.missing = TRUE,
      len = NULL,
      min.len = NULL,
      max.len = NULL,
      unique = FALSE,
      sorted = FALSE,
      null.ok = FALSE,
      .var.name = vname(x),
      add = NULL
    )

    testPOSIXct(
      x,
      lower = NULL,
      upper = NULL,
      any.missing = TRUE,
      all.missing = TRUE,
      len = NULL,
      min.len = NULL,
      max.len = NULL,
      unique = FALSE,
      sorted = FALSE,
      null.ok = FALSE
    )

    test_posixct(
      x,
      lower = NULL,
      upper = NULL,
      any.missing = TRUE,
      all.missing = TRUE,
      len = NULL,
      min.len = NULL,
      max.len = NULL,
      unique = FALSE,
      sorted = FALSE,
      null.ok = FALSE
    )

    expect_posixct(
      x,
      lower = NULL,
      upper = NULL,
      any.missing = TRUE,
      all.missing = TRUE,
      len = NULL,
      min.len = NULL,
      max.len = NULL,
      unique = FALSE,
      sorted = FALSE,
      null.ok = FALSE,
      info = NULL,
      label = vname(x)
    )

### Arguments

`x` | [any] Object to check.
`lower` | [`Date`] All non-missing dates in `x` must be >= this POSIXct time. Must be provided in the same timezone as `x`.
`upper` | [`Date`] All non-missing dates in `x` must be <= this POSIXct time. Must be provided in the same timezone as `x`.
`any.missing` | [`logical(1)`] Are vectors with missing values allowed? Default is `TRUE`.
`all.missing` | [`logical(1)`] Are vectors with no non-missing values allowed? Default is `TRUE`. Note that empty vectors do not have non-missing values.
`len` | [`integer(1)`] Exact expected length of `x`.
`min.len` | [`integer(1)`] Minimal length of `x`.
`max.len` | [`integer(1)`] Maximal length of `x`.
`unique` | [`logical(1)`] Must all values be unique? Default is `FALSE`.
`sorted` | [`logical(1)`] Elements must be sorted in ascending order. Missing values are ignored.
`null.ok` | [`logical(1)`] If set to `TRUE`, `x` may also be `NULL`. In this case only a type check of `x` is performed, all additional checks are disabled.
`.var.name` | [`character(1)`] Name of the checked object to print in assertions. Defaults to the heuristic implemented in `vname`.
`add` | [`AssertCollection`] Collection to store assertion messages. See `AssertCollection`.
`info` | [`character(1)`] Extra information to be included in the message for the testthat reporter. See `expect_that`.
`label` | [`character(1)`] Name of the checked object to print in messages. Defaults to the heuristic implemented in `vname`.

### Value

Depending on the function prefix: If the check is successful, the functions `assertAtomic`/`assert_atomic` return `x` invisibly, whereas `checkAtomic`/`check_atomic` and `testAtomic`/`test_atomic` return `TRUE`. If the check is not successful, `assertAtomic`/`assert_atomic` throws an error message, `testAtomic`/`test_atomic` returns `FALSE`, and `checkAtomic`/`check_atomic` return a string with the error message. The function `expect_atomic` always returns an `expectation`.

### See Also

Other basetypes: `checkArray()`, `checkAtomicVector()`, `checkAtomic()`, `checkCharacter()`, `checkComplex()`, `checkDataFrame()`, `checkDate()`, `checkDouble()`, `checkEnvironment()`, `checkFactor()`, `checkFormula()`, `checkFunction()`, `checkIntegerish()`, `checkInteger()`, `checkList()`, `checkLogical()`, `checkMatrix()`, `checkNull()`, `checkNumeric()`, `checkRaw()`, `checkVector()`

[Package checkmate version 2.1.0 Index]