help_create_title: create a title sequence

Description Usage Arguments Details

View source: R/insert_breaks.R

Description

This function returns a string that can be used as a title.

Usage

1
2
3
help_create_title(start = "##", fill = "this is a title",
  length = options()$strcode$char_length, sep = "sep_here", end = "----",
  enforce_length = TRUE)

Arguments

start

A sequence of letters to start the sequence

fill

A sequence to fill the sequence with. This is the actual title.

length

An integer value indicating how long the sequence should be

sep

A separator sequence to separate start and fill.

end

A character sequence that indicates what the end of the final sequence should look like.

Details

For Rstudio to recognize a hereby produced sequence as a title, it must start with # and end with at least 4 of the following characters: #, -, =.


XiaoliangJiang/IndependentStudy2017YW documentation built on May 29, 2019, 10:54 a.m.