xxx_box: Convert sentences into a box of comments

In Hzhang-ouce/ARTofR: To Insert Title, Divider, and Block of Comments

Convert sentences into a box of comments

Description

For user guide, please refer to https://github.com/Hzhang-ouce/ARTofR

Usage

xxx_box(mystring = NULL, center = FALSE)

xxx_box1(mystring = NULL, center = FALSE)

xxx_list(mystring = NULL, center = FALSE)

xxx_list1(mystring = NULL, center = FALSE)

Arguments

mystring	A string, will be a line of comment. If missing, the function will try to grab texts from your clipboard.
center	A logical value: Do you want the text strings centred? (alternative: left justified)

Details

xxx_box is for paragraph, xxx_list is for bullet points or numbered list.
Number 1 in xxx_box1 and xxx_list1 imply style 1.

Value

A character string vector returned invisibly, but automatically displayed in the console, the output will be saved into clipboard

Functions

• xxx_box1: Same as xxx_box but add border

• xxx_list: Same as xxx_box but looks better for bullet points list or numbered list

• xxx_list1: Same as xxx_list but add border

Examples

# COMMON WORKFLOW OF THIS PACKAGE
#
# 1. To insert a box of comments etc with your own text
# 2. copy the text you want from anywhere
# 3. call xxx_box1() etc without arguments to grab text from clipboard
# 4. decorated text will be displayed and sent to clipboard, NO NEED to copy them
# 5. paste it into your R script
#...............................................
# # SPECIFIC USAGE EXAMPLE:

xxx_box('test sentence, test sentence, test sentence, test sentence',center = FALSE )
xxx_box1('test sentence, test sentence, test sentence, test sentence',center = FALSE )
xxx_box1('test sentence, test sentence, test sentence, test sentence',center = TRUE )

Hzhang-ouce/ARTofR documentation built on Sept. 12, 2023, 11:56 p.m.