Number of observationsSource:
vec_size(x) returns the size of a vector.
TRUE if the size is zero,
The size is distinct from the
length() of a vector because it
generalises to the "number of observations" for 2d structures,
i.e. it's the number of rows in matrix or a data frame. This
definition has the important property that every column of a data
frame (even data frame and matrix columns) have the same size.
vec_size_common(...) returns the common size of multiple vectors.
list_sizes() returns an integer vector containing the size of each element
of a list. It is nearly equivalent to, but faster than,
map_int(x, vec_size), with the exception that
error on non-list inputs, as defined by
lengths() is to
vec_size(x) vec_size_common( ..., .size = NULL, .absent = 0L, .arg = "", .call = caller_env() ) list_sizes(x) vec_is_empty(x)
- x, ...
Vector inputs or
NULL, the default, the output size is determined by recycling the lengths of all elements of
.... Alternatively, you can supply
.sizeto force a known size; in this case,
The size used when no input is provided, or when all input is
NULL. If left as
NULLwhen no input is supplied, an error is thrown.
An argument name as a string. This argument will be mentioned in error messages as the input that is at the origin of a problem.
The execution environment of a currently running function, e.g.
caller_env(). The function will be mentioned in error messages as the source of the error. See the
abort()for more information.
An integer (or double for long vectors).
.absent if all inputs are
0L by default.
There is no vctrs helper that retrieves the number of columns: as this is a property of the type.
vec_size() is equivalent to
NROW() but has a name that is easier to
pronounce, and throws an error when passed non-vector inputs.
vec_size(matrix[, i, drop = FALSE])
The size of
NULL is hard-coded to
.absent when all inputs are
(if only some inputs are
NULL, they are simply ignored).
A default size of 0 makes sense because sizes are most often
queried in order to compute a total size while assembling a
collection of vectors. Since we treat
NULL as an absent input by
principle, we return the identity of sizes under addition to
reflect that an absent input doesn't take up any size.
Note that other defaults might make sense under different circumstances. For instance, a default size of 1 makes sense for finding the common size because 1 is the identity of the recycling rules.