xxx_divider1: Insert a divider (line break or page break)

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

Insert a divider (line break or page break)

Description

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

Usage

xxx_divider1(mystring = NULL)

xxx_divider2(mystring = NULL)

Arguments

mystring

the content of your break, must be one line only, not too long

Details

Divider is shorter than title for hierarchy purpose, title will be come a section (for folding) in Rstudio, but divider will not
There are two styles of break, xxx_divider1 and xxx_divider2
Please note that a super long divider string will result in an error
call xxx_divider1() will grab text from clipboard,
call xxx_divider1('') will make a line without text,
call xxx_divider1('mystring') will make a divider with 'mystring'

Value

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

Functions

• xxx_divider2: Same as xxx_divider1 but different style

Examples

# COMMON WORKFLOW OF THIS PACKAGE
#
# 1. To insert Dividers with your own text
# 2. copy the text you want from anywhere
# 3. call xxx_divider1() 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_divider1('mystring')
xxx_divider1('')
xxx_divider2('mystring')
xxx_divider2('')

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