-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
65 lines (46 loc) · 2.15 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
---
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%"
)
```
# rgrassdoc <img src="man/figures/logo.png" align="right" width=150/>
<!-- badges: start -->
[](http://www.gnu.org/licenses/gpl-3.0)
[](https://github.com/VLucet/rgrassdoc/actions)
[](https://codecov.io/gh/VLucet/rgrassdoc?branch=master)
[](https://CRAN.R-project.org/package=rgrassdoc)
[](https://CRAN.R-project.org/package=rgrassdoc/)
<!-- badges: end -->
Are you a user of `rgrass7`, the R interfacte to GRASS GIS? Do you find yourself looking at the online GRASS manuals all the time? `rgrassdoc` provide two simple functions, `man` and `browse`, which allow you to visualize the GRASS GIS manual page for any GRASS module, right in the RStudio Viewer pane (or to easily open the manual page in your browser). The goal is to fluidify your workflow when using `rgrass7`.
### Installation
Install from CRAN as such:
``` r
install.packages("rgrassdoc")
```
You can also install the dev version from GitHub like so:
``` r
devtools::install_github("vlucet/rgrassdoc")
```
### Example
The `man` function supports non standard evaluation for even less typing and faster access to the information:
```{r example, eval = TRUE}
library(rgrassdoc)
man(r.in.gdal)
```
`man` also supports partial matching:
```{r partial, eval = TRUE}
man(r.gdal)
```
You can also open the page in your browser with `browse`. Your browser will then of course support links to other pages of the manual:
```{r cars, eval = FALSE}
browse(v.overlay)
```
Using the RStudio viewer pane, this is what you can expect to see:
