https://github.com/vlucet/rgrassdoc

Consult GRASS GIS Documentation in the RStudio Viewer or your Browser.
https://github.com/vlucet/rgrassdoc

documentation grass-gis package r rspatial

Last synced: 2 months ago
JSON representation

Consult GRASS GIS Documentation in the RStudio Viewer or your Browser.

• Host: GitHub
• URL: https://github.com/vlucet/rgrassdoc
• Owner: VLucet
• Created: 2020-05-23T23:42:01.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-03-16T12:59:19.000Z (almost 4 years ago)
• Last Synced: 2024-01-27T00:48:13.919Z (11 months ago)
• Topics: documentation, grass-gis, package, r, rspatial
• Language: R
• Homepage: https://vlucet.github.io/rgrassdoc
• Size: 1.15 MB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.Rmd

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# rgrassdoc 

[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)

[![R build status](https://github.com/VLucet/rgrassdoc/workflows/R-CMD-check/badge.svg)](https://github.com/VLucet/rgrassdoc/actions)

[![Codecov test coverage](https://codecov.io/gh/VLucet/rgrassdoc/branch/master/graph/badge.svg)](https://codecov.io/gh/VLucet/rgrassdoc?branch=master)

[![CRAN Version](https://img.shields.io/cran/v/rgrassdoc?label=CRAN)](https://CRAN.R-project.org/package=rgrassdoc)

[![Downloads](https://cranlogs.r-pkg.org/badges/rgrassdoc?color=blue)](https://CRAN.R-project.org/package=rgrassdoc/)

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:

![Viewer Pane](man/figures/README-screenshot.png)