xxx_title1: Insert a title

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

Insert a title

Description

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

Usage

xxx_title1(mystring = NULL)

xxx_title0(mystring = NULL)

xxx_title2(mystring = NULL)

xxx_title3(mystring = NULL)

Arguments

mystring

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

Details

There are three levels of titles, inserting a title with xxx_title() will also add a section in Rstudio automatically.
Please note that a super long title string will result in an error
xxx_title0() was designed as the main title of the whole script
xxx_title1() is the largest header
xxx_title2() is the middle size header
xxx_title3() is the smallest header

Value

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

Functions

• xxx_title0: the middle size title

• xxx_title2: the middle size title

• xxx_title3: the smallest title

Examples

# COMMON WORKFLOW OF THIS PACKAGE
#
# 1. To insert titles with your own text
# 2. copy the text you want from anywhere
# 3. call xxx_title2() 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_title0('my title')
xxx_title1('my title')
xxx_title2('my title')
xxx_title3('my title')

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