R: Equality proxy

vec_proxy_equal {vctrs} | R Documentation

## Equality proxy

### Description

Returns a proxy object (i.e. an atomic vector or data frame of atomic vectors). For vctrs, this determines the behaviour of `==` and `!=` (via `vec_equal()`); `unique()`, `duplicated()` (via `vec_unique()` and `vec_duplicate_detect()`); `is.na()` and `anyNA()` (via `vec_equal_na()`).

### Usage

    vec_proxy_equal(x, ...)

### Arguments

`x` | A vector x.
`...` | These dots are for future extensions and must be empty.

### Details

The default method calls `vec_proxy()`, as the default underlying vector data should be equal-able in most cases. If your class is not equal-able, provide a `vec_proxy_equal()` method that throws an error.

If the proxy for `x` is a data frame, `vec_proxy_equal()` is recursively applied on all columns as well.

### Value

A 1d atomic vector or a data frame.

[Package vctrs version 0.2.2 Index]