insert_anchor: Insert a hash anchor

View source: R/anchoring.R

insert_anchorR Documentation

Insert a hash anchor

Description

Insert a hash anchor

Usage

insert_anchor(enclosing_start = "#<", enclosing_end = ">#",
  length_random_input = .Machine$integer.max, ...)

Arguments

enclosing_start

A string that specifies the left-hand side enclosing of the hash

enclosing_end

A string that specifies the right-hand-side enclosing of the hash. If NULL, then the reverse of enclosing_start is used.

length_random_input

A number giving the range from which to draw a random number.

...

further arguments to be passed to and from other methods, in in particular to digest

Details

The function draws a random number using sample from the range of length_random_input. Then, this number is hashed by calling the digest hash-function from the digest package. This hash is then wrapped between enclosing_start and enclosing_end.

Examples

## Not run: 
  # RStudio needs to run for this
  insert_anchor(enclosing_start = "#!")
  
## End(Not run)

lorenzwalthert/strcode documentation built on May 11, 2023, 12:10 a.m.