---
title: "To Insert Title, Divider, and Block of Comments"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{User_guide}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
```

## ARTofR

Have you ever typed something like this in your R script as a section break:

```r

 #.........................just a example.........................


```

ARTofR is designed to help you do this, by auto-inserting title, divider and block of comments, for example:

`xxx_divider1('just a example')` will give you

```r

 #.........................just a example.........................


```

`xxx_title2('another example')` will give you

```r

##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
##                              another example                             ----
##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


```

ARTofR is a wrapper of bannerCommenter::banner(), written with thanks to the author, Bill Venables

## Installation

Install from CRAN:

``` r
install.packages('ARTofR')
```

Install the developing version of ARTofR:

``` r
# install.packages("devtools")
devtools::install_github("Hzhang-ouce/ARTofR")
```

## Complete user guide:

**User guide at** [Hzhang-ouce-ARTofR](https://github.com/Hzhang-ouce/ARTofR)