chk_omitted: Check whether dimension(s) identified by an index are...

Description Usage Arguments See Also Examples

View source: R/chk-composite.R

Description

chk_omitted checks that a dimension is omitted, and chk_not_omitted checks that a dimension is not omitted.

Usage

1
2
3
4
5
6
7
chk_omitted(index, map_dim, name_index, name_dim)

chk_not_omitted(index, map_dim, name_index, name_dim)

err_omitted(index, map_dim, name_index, name_dim)

err_not_omitted(index, map_dim, name_index, name_dim)

Arguments

index

An integer vector, identifying dimensions of array self

map_dim

Integer vector mapping dimensions of array self to dimensions of array oth.

name_index

Name of index.

name_dim

Name of the dimension that should or should not be omitted.

See Also

chk_map_dim

Examples

1
2
3
4
5
6
7
8
chk_omitted(index = 2L,
              map_dim = c(1L, 0L, 2L),
              name_index = "indices_orig_self",
              name_dim = "origin")
chk_not_omitted(index = 3L,
                  map_dim = c(1L, 0L, 2L),
                  name_index = "indices_dest_self",
                  name_dim = "destination")

johnrbryant/demcheck documentation built on Dec. 31, 2021, 11:57 a.m.