-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.Rmd
100 lines (61 loc) · 4.32 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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# annotater <img src='man/figures/logo.png' align="right" width="120" />
<!-- badges: start -->
[](https://CRAN.R-project.org/package=annotater)
[](https://app.codecov.io/gh/luisDVA/annotater?branch=master)
[](https://cran.r-project.org/package=annotater)
[](https://cran.r-project.org/package=annotater)
<!-- badges: end -->
The goal of `annotater` is to annotate package load calls in character strings and R/Rmd files, so we can have an idea of the overall purpose of the libraries we're loading.
### What do my loaded packages do?
_note: the gifs below may show fewer addins than the current release but the functionality is unchanged_
<img src='https://raw.githubusercontent.com/luisdva/annotater/master/inst/media/annotcalls.gif' align="center" width="400px" />
### Where did I get them?
<img src='https://raw.githubusercontent.com/luisdva/annotater/master/inst/media/repos2.gif' align="center" width="400px" />
---
The two annotation types are also available together:
<img src='https://raw.githubusercontent.com/luisdva/annotater/master/inst/media/repostitles.gif' align="center" width="400px" />
Thanks to [Juan Cruz Rodriguez](https://github.com/jcrodriguez1989), we can now annotate which functions from each package are being called in a script.
<img src='https://raw.githubusercontent.com/luisdva/annotater/master/inst/media/jcruz.gif' align="center" width="400px" />
As of version 0.2.3, loaded datasets can also be added as annotations.
## `pacman` compatibility
Users of the [`pacman`](https://cran.r-project.org/package=pacman) package can now use all `annotater` functions on `p_load` calls. This includes calls with multiple package names (e.g. `p_load(ggplot2,purrr)`), which will be split up across lines for readability.
<img src='https://raw.githubusercontent.com/luisdva/annotater/master/inst/media/annotpacmanFns.gif' align="center" width="400px" />
<img src='https://raw.githubusercontent.com/luisdva/annotater/master/inst/media/annotpacmanRepos.gif' align="center" width="400px" />
## Installation
Install the CRAN release or the development version with:
``` r
# Install annotater from CRAN:
install.packages("annotater")
# install.packages("remotes")
remotes::install_github("luisDVA/annotater")
```
Restart RStudio after the installation for the addins to load properly.
### When using the addins, make sure the focus (blinking cursor) is on an open RStudio R file in the 'source' pane.
## Example
These are the possible annotations, which can be added to character strings (with one line per element), or applied to .R or .Rmd files in RStudio through their corresponding addins.
```r
library(annotater)
test_string <-c("library(boot)\nrequire(Matrix)")
writeLines(annotate_pkg_calls(test_string))
writeLines(annotate_repo_source(test_string))
writeLines(annotate_repo_source(test_string))
```
Entire .R files can also be parsed and annotated with the `annotate_script` function.
### A note on the `tidyverse`
The `tidyverse` package is a meta-package with few exported functions of its own, so the annotation tools provided here (`annotate_fun_calls`) will not match the functions from the various individual packages (such as `dplyr` or `readr`) that get attached when loading `tidyverse`. Consider using the experimental `expand_metapackages` function first if annotations for function calls are desired.
### More on metapackages
`annotater` can now expand metapackage load calls into separate `library` calls for the individual packages that form the core of `tidyverse`, `tidymodels`, and `easystats`.
Feedback welcome
Thanks to [Jonathan Carroll](https://github.com/jonocarroll), [Firat Melih Yilmaz](https://github.com/fmyilmaz), [Paul Schmidt](https://github.com/SchmidtPaul), and [Achaz von Hardenberg](https://github.com/achazhardenberg) for feedback and suggestions.