get_surround: Get surrounding elements of an element in a matrix.

Description Usage Arguments Examples

Description

This function extracts all surrounding elements of a specified element in a matrix and returns the result as a vector.

Usage

1
get_surround(data, index, type = "all")

Arguments

data

Matrix.

index

Index position of element. Input as a vector of row then column positions.

type

Takes values of "direct" and "all". "direct" returns only the elements directly in contact with the specified element, whereas "all" returns every surrounding element including diagonals. Defaults to "all".

Examples

1
2
M = matrix(1:20,4,5)
get_surround(data = M, index = c(2,3))


Search within the BoardGames package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.