string_ruler: String ruler Fuction to assist with visualizing positions of...

View source: R/char_utils.R

string_rulerR Documentation

String ruler Fuction to assist with visualizing positions of a string, usually used with long fixed width character vectors

Description

String ruler Fuction to assist with visualizing positions of a string, usually used with long fixed width character vectors

Usage

string_ruler(x, split = 0, under = T, uchar = "-", nl = 0, nlchar = " ")

Arguments

x

- character: string to measure

split

- integer: split lines every [split] characters

under

- logical: underline the ruler digits

uchar

- character: character to use for the underline (default="-")

nl

- integer: number of newlines after each ruled line

nlchar

- character: character to use for the new lines (default=" ")

Value

character: string with "ruler" above


JahNorr/orrr documentation built on Jan. 29, 2025, 5:11 p.m.