{"id":16732292,"url":"https://github.com/vlucet/rgrassdoc","last_synced_at":"2025-04-10T11:24:48.428Z","repository":{"id":56935143,"uuid":"266438006","full_name":"VLucet/rgrassdoc","owner":"VLucet","description":"Consult GRASS GIS Documentation in the RStudio Viewer or your Browser.","archived":false,"fork":false,"pushed_at":"2021-03-16T12:59:19.000Z","size":1201,"stargazers_count":6,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-24T10:11:56.566Z","etag":null,"topics":["documentation","grass-gis","package","r","rspatial"],"latest_commit_sha":null,"homepage":"https://vlucet.github.io/rgrassdoc","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/VLucet.png","metadata":{"files":{"readme":"README.Rmd","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-23T23:42:01.000Z","updated_at":"2023-07-14T22:16:12.000Z","dependencies_parsed_at":"2022-08-21T06:50:46.188Z","dependency_job_id":null,"html_url":"https://github.com/VLucet/rgrassdoc","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VLucet%2Frgrassdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VLucet%2Frgrassdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VLucet%2Frgrassdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VLucet%2Frgrassdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VLucet","download_url":"https://codeload.github.com/VLucet/rgrassdoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248208612,"owners_count":21065203,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","grass-gis","package","r","rspatial"],"created_at":"2024-10-12T23:40:42.468Z","updated_at":"2025-04-10T11:24:48.408Z","avatar_url":"https://github.com/VLucet.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\"\n)\n```\n\n# rgrassdoc \u003cimg src=\"man/figures/logo.png\" align=\"right\" width=150/\u003e\n\n\u003c!-- badges: start --\u003e\n[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)\n[![R build status](https://github.com/VLucet/rgrassdoc/workflows/R-CMD-check/badge.svg)](https://github.com/VLucet/rgrassdoc/actions)\n[![Codecov test coverage](https://codecov.io/gh/VLucet/rgrassdoc/branch/master/graph/badge.svg)](https://codecov.io/gh/VLucet/rgrassdoc?branch=master)\n\n[![CRAN Version](https://img.shields.io/cran/v/rgrassdoc?label=CRAN)](https://CRAN.R-project.org/package=rgrassdoc)\n[![Downloads](https://cranlogs.r-pkg.org/badges/rgrassdoc?color=blue)](https://CRAN.R-project.org/package=rgrassdoc/)\n\u003c!-- badges: end --\u003e\n\nAre 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`. \n\n### Installation\n\nInstall from CRAN as such:\n\n``` r\ninstall.packages(\"rgrassdoc\")\n```\n\nYou can also install the dev version from GitHub like so:\n\n``` r\ndevtools::install_github(\"vlucet/rgrassdoc\")\n```\n\n### Example\n\nThe `man` function supports non standard evaluation for even less typing and faster access to the information:\n\n```{r example, eval = TRUE}\nlibrary(rgrassdoc)\n\nman(r.in.gdal)\n```\n\n`man` also supports partial matching:\n```{r partial, eval = TRUE}\nman(r.gdal)\n```\nYou can also open the page in your browser with `browse`. Your browser will then of course support links to other pages of the manual:\n\n```{r cars, eval = FALSE}\nbrowse(v.overlay)\n```\n\nUsing the RStudio viewer pane, this is what you can expect to see:\n\n![Viewer Pane](man/figures/README-screenshot.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvlucet%2Frgrassdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvlucet%2Frgrassdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvlucet%2Frgrassdoc/lists"}