R/rmd_headings.R

Defines functions rmd_b_heading_01b_subtitle rmd_b_heading_01a_title rmd_b_heading_6 rmd_b_heading_5 rmd_b_heading_4 rmd_b_heading_3 rmd_b_heading_2 rmd_b_heading_1

Documented in rmd_b_heading_01a_title rmd_b_heading_01b_subtitle rmd_b_heading_1 rmd_b_heading_2 rmd_b_heading_3 rmd_b_heading_4 rmd_b_heading_5 rmd_b_heading_6

#' Format text as R Markdown headings.
#'
#' RStudio add-ins to format text as R Markdown headings.
#'
#' @name rmd_headings
#' @export
rmd_b_heading_1 <- function() {
    rs_insert_before_first_selected_row("# ",
                                        ensure_blank_above = TRUE)
}
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#' @rdname rmd_headings
#' @export
rmd_b_heading_2 <- function() {
    rs_insert_before_first_selected_row("## ",
                                        ensure_blank_above = TRUE)
}
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#' @rdname rmd_headings
#' @export
rmd_b_heading_3 <- function() {
    rs_insert_before_first_selected_row("### ",
                                        ensure_blank_above = TRUE)
}
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#' @rdname rmd_headings
#' @export
rmd_b_heading_4 <- function() {
    rs_insert_before_first_selected_row("#### ",
                                        ensure_blank_above = TRUE)
}
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#' @rdname rmd_headings
#' @export
rmd_b_heading_5 <- function() {
    rs_insert_before_first_selected_row("##### ",
                                        ensure_blank_above = TRUE)
}
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#' @rdname rmd_headings
#' @export
rmd_b_heading_6 <- function() {
    rs_insert_before_first_selected_row("###### ",
                                        ensure_blank_above = TRUE)
}
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#' @rdname rmd_headings
#' @export
rmd_b_heading_01a_title <- function() {

    text <- repeat_symbol("=", 60)
    rs_enclose_first_row_with_lines(below = text,
                                    ensure_blank_above = TRUE)
}
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#' @rdname rmd_headings
#' @export
rmd_b_heading_01b_subtitle <- function() {

    text <- repeat_symbol("-", 60)
    rs_enclose_first_row_with_lines(below = text,
                                    ensure_blank_above = TRUE)
}
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GegznaV/spAddins documentation built on Nov. 20, 2020, 10:42 p.m.