my_own_banner {ARTofR} | R Documentation |
Core functions for comment making
Description
This is modified from bannerCommenter::banner()
, the main modification is to extend the comment length (minHashes) to 80
Usage
my_own_banner(
x,
...,
emph = FALSE,
snug = FALSE,
upper = emph,
centre = !fold,
leftSideHashes = 2 + emph,
rightSideHashes = leftSideHashes,
minHashes = (!snug) * (80 + 10 * emph),
numLines = 1 + emph,
bandChar = "#",
center = centre,
fold = FALSE,
maxChar = 75
)
fold_it(x, maxChar, exdent = 0)
Arguments
x |
the string |
... |
Zero or more additional strings as extra lines. Strings may contain newline characters resulting in further line breaks. |
emph |
A logical value: Do you want this to be an emphasised comment? |
snug |
A logical value: Do you want the decoration to hug the strings closely? |
upper |
A logical value: Do you want the strings converted to upper case? |
centre |
A logical value: Do you want the text strings centred? (alternative: left justified) |
leftSideHashes |
A positive integer: How many hashes go on the left side? |
rightSideHashes |
A non-negative integer: How many hashes go on the right side? |
minHashes |
A non-negative integer: What is the minimum number of hashes in the boundary lines? |
numLines |
A non-negative integer: How many lines of hashes above and below do you want? |
bandChar |
A single character. Used instead of # for all characters in the bands around the text, apart from the first character of every line. |
center |
Alternative spelling of |
fold |
Logical: should the text be folded to ensure lines are not too long? |
maxChar |
same as width in str_wrap |
exdent |
for xxx_list() |
Value
A character string vector returned invisibly, but automatically displayed in the console
Functions
-
fold_it
: sub-function to fold sentence, don't use this in other circumstance
Examples
my_own_banner("This should appear clearly and stand out.",
"The lines are left justified by default.")
##This is NOT recommended!!!
##This is NOT recommended!!!
##This is NOT recommended!!!
##pls use bannerCommenter::banner()