S7 class for vecvec
Description
class_vecvec() constructs a new vecvec object from a list of vectors. It is
designed to be performant with minimal checks on the inputs. Direct use of
class_vecvec() is useful for developers, but for users it is recommended to
use vecvec() to create vecvec objects.
Usage
class_vecvec(x = list(), i = seq_len(sum(lengths(x))))class_vecvec(x = list(), i = seq_len(sum(lengths(x))))
Arguments
x |
An unnamed list of arbitrary vectors. The vectors can be of different types and lengths, but they must all be vectors (according to vctrs::vec_is). Adjacent vectors of the same type will be combined together into a single vector. |
i |
A vector of integers specifying the location of each element in |
Value
A vector of vectors of S7 object of class class_vecvec.
Examples
# Create a vecvec prototype class_vecvec() # Construct a vecvec from a list of vectors class_vecvec(list(letters, rnorm(10))) # Fully specify a vecvec with locations class_vecvec( x = list(letters, rnorm(10)), i = c(1:3, 27:31, 26:4, 32:36) )# Create a vecvec prototype class_vecvec() # Construct a vecvec from a list of vectors class_vecvec(list(letters, rnorm(10))) # Fully specify a vecvec with locations class_vecvec( x = list(letters, rnorm(10)), i = c(1:3, 27:31, 26:4, 32:36) )
Test if an object is a vecvec
Description
Test if an object is a vecvec
Usage
is_vecvec(x)is_vecvec(x)
Arguments
x |
Object to test. |
Value
TRUE if x inherits from class_vecvec, FALSE otherwise.
See Also
vecvec() to create a vecvec object.
Examples
vv <- vecvec(1:3, letters) is_vecvec(vv) is_vecvec(1:3)vv <- vecvec(1:3, letters) is_vecvec(vv) is_vecvec(1:3)
Correlation, Variance and Covariance
Description
var, cov, and cor compute the variance of x and the covariance or
correlation of x and y if these are vectors. If x and y are matrices then
the covariances (or correlations) between the columns of x and the columns
of y are computed.
These functions mask and wrap the stats::var, stats::cov, and
stats::cor functions to add support for vecvec objects. More details
can be found in the documentation for those functions.
Usage
var(x, ...) cov(x, ...) cor(x, ...)var(x, ...) cov(x, ...) cor(x, ...)
Arguments
x |
a numeric vector, matrix or data frame. |
... |
Additional arguments passed to |
See Also
stats::var(), stats::cov(), stats::cor()
Coerce a vector of vectors to a single typed vector
Description
![[Stable]](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB3aWR0aD0iOTgiIGhlaWdodD0iMjAiIHJvbGU9ImltZyIgYXJpYS1sYWJlbD0ibGlmZWN5Y2xlOiBzdGFibGUiPgogICAgPHRpdGxlPmxpZmVjeWNsZTogc3RhYmxlPC90aXRsZT4KICAgIDxsaW5lYXJHcmFkaWVudCBpZD0icyIgeDI9IjAiIHkyPSIxMDAlIj4KICAgICAgICA8c3RvcCBvZmZzZXQ9IjAiIHN0b3AtY29sb3I9IiNiYmIiIHN0b3Atb3BhY2l0eT0iLjEiIC8+CiAgICAgICAgPHN0b3Agb2Zmc2V0PSIxIiBzdG9wLW9wYWNpdHk9Ii4xIiAvPgogICAgPC9saW5lYXJHcmFkaWVudD4KICAgIDxjbGlwUGF0aCBpZD0iciI+CiAgICAgICAgPHJlY3Qgd2lkdGg9Ijk4IiBoZWlnaHQ9IjIwIiByeD0iMyIgZmlsbD0iI2ZmZiIgLz4KICAgIDwvY2xpcFBhdGg+CiAgICA8ZyBjbGlwLXBhdGg9InVybCgjcikiPgogICAgICAgIDxyZWN0IHdpZHRoPSI1NSIgaGVpZ2h0PSIyMCIgZmlsbD0iIzU1NSIgLz4KICAgICAgICA8cmVjdCB4PSI1NSIgd2lkdGg9IjQzIiBoZWlnaHQ9IjIwIiBmaWxsPSIjNGMxIiAvPgogICAgICAgIDxyZWN0IHdpZHRoPSI5OCIgaGVpZ2h0PSIyMCIgZmlsbD0idXJsKCNzKSIgLz4KICAgIDwvZz4KICAgIDxnIGZpbGw9IiNmZmYiIHRleHQtYW5jaG9yPSJtaWRkbGUiIGZvbnQtZmFtaWx5PSJWZXJkYW5hLEdlbmV2YSxEZWphVnUgU2FucyxzYW5zLXNlcmlmIiB0ZXh0LXJlbmRlcmluZz0iZ2VvbWV0cmljUHJlY2lzaW9uIiBmb250LXNpemU9IjExMCI+CiAgICAgICAgPHRleHQgYXJpYS1oaWRkZW49InRydWUiIHg9IjI4NSIgeT0iMTUwIiBmaWxsPSIjMDEwMTAxIiBmaWxsLW9wYWNpdHk9Ii4zIiB0cmFuc2Zvcm09InNjYWxlKC4xKSIgdGV4dExlbmd0aD0iNDUwIj4KICAgICAgbGlmZWN5Y2xlCiAgICA8L3RleHQ+CiAgICAgICAgPHRleHQgeD0iMjg1IiB5PSIxNDAiIHRyYW5zZm9ybT0ic2NhbGUoLjEpIiBmaWxsPSIjZmZmIiB0ZXh0TGVuZ3RoPSI0NTAiPgogICAgICBsaWZlY3ljbGUKICAgIDwvdGV4dD4KICAgICAgICA8dGV4dCBhcmlhLWhpZGRlbj0idHJ1ZSIgeD0iNzU1IiB5PSIxNTAiIGZpbGw9IiMwMTAxMDEiIGZpbGwtb3BhY2l0eT0iLjMiIHRyYW5zZm9ybT0ic2NhbGUoLjEpIiB0ZXh0TGVuZ3RoPSIzMzAiPgogICAgICBzdGFibGUKICAgIDwvdGV4dD4KICAgICAgICA8dGV4dCB4PSI3NTUiIHk9IjE0MCIgdHJhbnNmb3JtPSJzY2FsZSguMSkiIGZpbGw9IiNmZmYiIHRleHRMZW5ndGg9IjMzMCI+CiAgICAgIHN0YWJsZQogICAgPC90ZXh0PgogICAgPC9nPgo8L3N2Zz4K)
Flattens a vecvec into a plain R vector by casting all elements to a
common type. This is the inverse of vecvec().
Type resolution follows vctrs coercion rules: when ptype is NULL the
common type is determined automatically from the slots of x via
vctrs::vec_ptype_common(). If no common type can be found (e.g. all slots
are empty), the result falls back to logical().
Usage
unvecvec(x, ptype = NULL)unvecvec(x, ptype = NULL)
Arguments
x |
A |
ptype |
A prototype specifying the desired output type, e.g.
|
Value
A vector of length length(x) and type ptype (or the inferred
common type when ptype = NULL). Positions corresponding to NA indices
in the underlying vecvec structure are filled with NA.
See Also
vecvec() to create a vecvec; vctrs::vec_ptype_common() for
the type inference rules; vctrs::vec_cast() for the casting rules.
Examples
vv <- vecvec(1:3, c(4.5, 5.5)) # Automatic type inference: integer + double -> double unvecvec(vv) # Force a specific output type unvecvec(vv, ptype = character())vv <- vecvec(1:3, c(4.5, 5.5)) # Automatic type inference: integer + double -> double unvecvec(vv) # Force a specific output type unvecvec(vv, ptype = character())
Create a vector of vectors
Description
A vecvec is a vector that holds elements of different types without
coercing them to a common type. Unlike a list of vectors, a vecvec behaves
as a flat vector (hence vector of vectors). This means that you can
operations (such as indexing, arithmetic, and statistics) apply across all
elements of a vecvec as if they were combined into a single vector.
Mixed-type vectors can be useful if you need to store heterogeneous data in a vector-like structure. In most cases, I believe this is bad practice for data analytics, but this could be useful for tidying up messy data. The most valuable use case for vecvec is as a data structure for mixed-type semantic vectors. This package is used by mixtime and distributional to create vectors of time with different chronons and distributions with different shapes.
To convert a vecvec back to a plain typed vector, use unvecvec(), which
casts all elements to a common type via vctrs::vec_cast().
Usage
vecvec(...)vecvec(...)
Arguments
... |
Vectors to combine. Each vector is stored as a separate typed slot; no type coercion is performed. |
Value
A vecvec object whose length equals the total number of elements
across all input vectors.
See Also
unvecvec() to coerce a vecvec to a single-typed vector;
is_vecvec() to test whether an object is a vecvec.
Examples
# Mixed types are preserved without coercion vv <- vecvec(Sys.Date(), rnorm(3), letters) vv # .[i] Indexing works like a flat vector vv[c(1L, 3L, 7L)] # .[[i]] drops to the original vector type vv[[2L]]# Mixed types are preserved without coercion vv <- vecvec(Sys.Date(), rnorm(3), letters) vv # .[i] Indexing works like a flat vector vv[c(1L, 3L, 7L)] # .[[i]] drops to the original vector type vv[[2L]]
Apply a function to each vector of the vecvec
Description
The vecvec_apply() function applies a function .f to each vector in the
vecvec vectors.
Usage
vecvec_apply(x, .f, ...)vecvec_apply(x, .f, ...)
Arguments
x |
A vecvec object |
.f |
A function to apply to each vector |
... |
Additional arguments passed to |
Value
A vecvec data type with the same structure as x but with each
vector transformed by .f.
Function factory for vecvec_apply
Description
The vecvec_apply_fn() function is a function factory that creates applies
the function .f to each vector and optionally simplifies the result with
[unvecvec()]. The function matches the forms of the original function
.f and can be used to define methods for generic functions that apply to
vecvec objects. If .f is a primitive function, the resulting function will
have a apply over an argument x and pass through ....
Usage
vecvec_apply_fn(.f, ptype = NULL, SIMPLIFY = !is.null(ptype))vecvec_apply_fn(.f, ptype = NULL, SIMPLIFY = !is.null(ptype))
Arguments
.f |
A function to apply to each vector |
ptype |
A prototype to simplify to. If |
SIMPLIFY |
If |
Value
A function that applies .f to each vector of a vecvec object and
optionally simplifies the result.
Register methods for a vecvec subclass
Description
Call vecvec_register() inside your package's .onLoad() function to
register the S3 methods that allow a custom
vecvec subclass to participate in the
vctrs vector system.
Usage
vecvec_register(x)vecvec_register(x)
Arguments
x |
An S7 class object that extends class_vecvec. Typically the
class object created by |
Details
Specifically, vecvec_register() registers:
-
vec_cast.<class>.*methods, so that other types can be cast to your vecvec subclass. -
vec_cast.*.<class>methods, so that your vecvec subclass can be cast from other types.
Value
NULL, invisibly. Called for its side effects.
Examples
## Not run: # In your package, define a vecvec subclass: class_myvec <- S7::new_class( "myvec", parent = vecvec::class_vecvec ) # Then register it in .onLoad(): .onLoad <- function(libname, pkgname) { S7::methods_register() vecvec::vecvec_register(class_myvec) } ## End(Not run)## Not run: # In your package, define a vecvec subclass: class_myvec <- S7::new_class( "myvec", parent = vecvec::class_vecvec ) # Then register it in .onLoad(): .onLoad <- function(libname, pkgname) { S7::methods_register() vecvec::vecvec_register(class_myvec) } ## End(Not run)