-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
51 lines (39 loc) · 1.27 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
set.seed(42)
```
# Rprofile
<!-- badges: start -->
[![R-CMD-check](https://github.com/jmbarbone/Rprofile/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jmbarbone/Rprofile/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
The goal of Rprofile is to provide simple, non-intrusive functions for development that are not intended to be used in final packages.
These function to assist during the development process.
## Installation
You can install the developmental version of Rprofile with:
``` r
remotes::install_github("jmbarbone/Rprofile")
```
## Example
```{r example}
library(Rprofile)
.NiceMessage()
.CharacterIndex("your string here")
```
```r
.RemoveAll() # removes all objects
.Reload() # removes objects and restart Rstudio session
.ResetOptions() # resets options
.GitBranchPrompt() # shows git branch
.Todos(), .Fixmes() # shows comments marked as TODO or FIXME
.CheckCranStatus() # shows current CRAN status for packages by authors
.Search() # pretty print of search()
```