checkDouble {checkmate} | R Documentation |

## Check that an argument is a vector of type double

### Description

Check that an argument is a vector of type double

### Usage

```
checkDouble(
x,
lower = -Inf,
upper = Inf,
finite = FALSE,
any.missing = TRUE,
all.missing = TRUE,
len = NULL,
min.len = NULL,
max.len = NULL,
unique = FALSE,
sorted = FALSE,
names = NULL,
typed.missing = FALSE,
null.ok = FALSE
)
check_double(
x,
lower = -Inf,
upper = Inf,
finite = FALSE,
any.missing = TRUE,
all.missing = TRUE,
len = NULL,
min.len = NULL,
max.len = NULL,
unique = FALSE,
sorted = FALSE,
names = NULL,
typed.missing = FALSE,
null.ok = FALSE
)
assertDouble(
x,
lower = -Inf,
upper = Inf,
finite = FALSE,
any.missing = TRUE,
all.missing = TRUE,
len = NULL,
min.len = NULL,
max.len = NULL,
unique = FALSE,
sorted = FALSE,
names = NULL,
typed.missing = FALSE,
null.ok = FALSE,
.var.name = vname(x),
add = NULL
)
assert_double(
x,
lower = -Inf,
upper = Inf,
finite = FALSE,
any.missing = TRUE,
all.missing = TRUE,
len = NULL,
min.len = NULL,
max.len = NULL,
unique = FALSE,
sorted = FALSE,
names = NULL,
typed.missing = FALSE,
null.ok = FALSE,
.var.name = vname(x),
add = NULL
)
testDouble(
x,
lower = -Inf,
upper = Inf,
finite = FALSE,
any.missing = TRUE,
all.missing = TRUE,
len = NULL,
min.len = NULL,
max.len = NULL,
unique = FALSE,
sorted = FALSE,
names = NULL,
typed.missing = FALSE,
null.ok = FALSE
)
test_double(
x,
lower = -Inf,
upper = Inf,
finite = FALSE,
any.missing = TRUE,
all.missing = TRUE,
len = NULL,
min.len = NULL,
max.len = NULL,
unique = FALSE,
sorted = FALSE,
names = NULL,
typed.missing = FALSE,
null.ok = FALSE
)
expect_double(
x,
lower = -Inf,
upper = Inf,
finite = FALSE,
any.missing = TRUE,
all.missing = TRUE,
len = NULL,
min.len = NULL,
max.len = NULL,
unique = FALSE,
sorted = FALSE,
names = NULL,
typed.missing = FALSE,
null.ok = FALSE,
info = NULL,
label = vname(x)
)
```

### Arguments

`x` |
[any] |

`lower` |
[ |

`upper` |
[ |

`finite` |
[ |

`any.missing` |
[ |

`all.missing` |
[ |

`len` |
[ |

`min.len` |
[ |

`max.len` |
[ |

`unique` |
[ |

`sorted` |
[ |

`names` |
[ |

`typed.missing` |
[ |

`null.ok` |
[ |

`.var.name` |
[ |

`add` |
[ |

`info` |
[ |

`label` |
[ |

### Details

This function does not distinguish between
`NA`

, `NA_integer_`

, `NA_real_`

, `NA_complex_`

`NA_character_`

and `NaN`

.

### Value

Depending on the function prefix:
If the check is successful, the functions
`assertDouble`

/`assert_double`

return
`x`

invisibly, whereas
`checkDouble`

/`check_double`

and
`testDouble`

/`test_double`

return
`TRUE`

.
If the check is not successful,
`assertDouble`

/`assert_double`

throws an error message,
`testDouble`

/`test_double`

returns `FALSE`

,
and `checkDouble`

/`check_double`

return a string with the error message.
The function `expect_double`

always returns an
`expectation`

.

### See Also

Other basetypes:
`checkArray()`

,
`checkAtomicVector()`

,
`checkAtomic()`

,
`checkCharacter()`

,
`checkComplex()`

,
`checkDataFrame()`

,
`checkDate()`

,
`checkEnvironment()`

,
`checkFactor()`

,
`checkFormula()`

,
`checkFunction()`

,
`checkIntegerish()`

,
`checkInteger()`

,
`checkList()`

,
`checkLogical()`

,
`checkMatrix()`

,
`checkNull()`

,
`checkNumeric()`

,
`checkPOSIXct()`

,
`checkRaw()`

,
`checkVector()`

### Examples

```
testDouble(1)
testDouble(1L)
testDouble(1, min.len = 1, lower = 0)
```

*checkmate*version 2.3.1 Index]