https://github.com/coolbutuseless/rd2list

Convert Rd documentation to a structured, human-readable list
https://github.com/coolbutuseless/rd2list

Last synced: 2 months ago
JSON representation

Convert Rd documentation to a structured, human-readable list

• Host: GitHub
• URL: https://github.com/coolbutuseless/rd2list
• Owner: coolbutuseless
• License: mit
• Created: 2018-12-26T23:15:10.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2018-12-27T04:23:39.000Z (almost 6 years ago)
• Last Synced: 2024-08-13T07:13:22.482Z (4 months ago)
• Language: R
• Homepage:
• Size: 16.6 KB
• Stars: 14
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - coolbutuseless/rd2list - Convert Rd documentation to a structured, human-readable list (R)

README

        
---

output: github_document

---

```{r setup, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

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

  out.width = "100%"

)

```

# rd2list

[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/coolbutuseless/rd2list?branch=master&svg=true)](https://ci.appveyor.com/project/coolbutuseless/rd2list)

[![Travis build status](https://travis-ci.org/coolbutuseless/rd2list.svg?branch=master)](https://travis-ci.org/coolbutuseless/rd2list)

[![Coverage status](https://codecov.io/gh/coolbutuseless/rd2list/branch/master/graph/badge.svg)](https://codecov.io/github/coolbutuseless/rd2list?branch=master)

`rd2list` is a package for extracting R documentation into a structured, 

human-readable list.  Use this package if you've ever wanted to get the help text for a function as a string.

* `get_doc()` - get a structured, human-readable list of the documentation for a function.

* `get_rd_doc()` - fetch the Rd object for a function from an installed package.

* `rd2list()` - parse an Rd object into a structured, human-readable list.

## Installation

You can install from github with:

``` r

remotes::install_github("coolbutuseless/rd2list")

```

## Example - Getting documentation as a list

```{r example}

doc <- rd2list::get_doc(function_name = 'geom_path', package = 'ggplot2')

doc$title

```

```{r eval = FALSE}

doc$description

```

```{r echo = FALSE, width = 10}

# Jumping through some hoops. must be an easier way...

cat(paste(strwrap(doc$description), collapse="\n"))

```

```{r}

doc$arguments$linejoin

```

```{r}

doc$alias

```

## Example - Getting documentation as an Rd object

The raw Rd documentation object can be fetched using `get_rd_doc()`.

```{r eval = FALSE}

rd2list::get_rd_doc(function_name = 'diag', package_name = 'base')

```

```{r eval = FALSE}

$title

$title[[1]]

[1] "Matrix Diagonals"

attr(,"Rd_tag")

[1] "TEXT"

attr(,"Rd_tag")

[1] "\\title"

$name

$name[[1]]

[1] "diag"

attr(,"Rd_tag")

[1] "VERB"

attr(,"Rd_tag")

[1] "\\name"

$alias

$alias[[1]]

[1] "diag"

attr(,"Rd_tag")

[1] "VERB"

attr(,"Rd_tag")

[1] "\\alias"

[... output trimmed]

```

# Related documents and packages:

* [Rd parsing](https://developer.r-project.org/parseRd.pdf) - developer documentation

  for parsing and understanding the `Rd` format.

* [Rd2md](https://cran.r-project.org/package=Rd2md) converts Rd documentation to 

  a markdown document.

* [gbRd](https://cran.r-project.org/package=gbRd) which 

  provides utilities for processing Rd objects and files.

* [Rdpack](https://cran.r-project.org/package=Rdpack) which 

  provide functions for manipulation of R documentation objects.

* [fgui](https://cran.r-project.org/package=fgui) used to offer some functionality

  for extracting document. `fgui::parseHelp()` used to work, but has been disabled by author.