https://github.com/gaborcsardi/roxygenlabs

Experimental roxygen tags and extensions
https://github.com/gaborcsardi/roxygenlabs

Last synced: 26 days ago
JSON representation

Experimental roxygen tags and extensions

• Host: GitHub
• URL: https://github.com/gaborcsardi/roxygenlabs
• Owner: gaborcsardi
• License: other
• Created: 2019-12-22T09:32:28.000Z (over 5 years ago)
• Default Branch: x
• Last Pushed: 2020-07-10T09:26:44.000Z (almost 5 years ago)
• Last Synced: 2024-08-13T07:14:32.914Z (8 months ago)
• Language: R
• Size: 30.3 KB
• Stars: 19
• Watchers: 1
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - gaborcsardi/roxygenlabs - Experimental roxygen tags and extensions (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

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

  out.width = "100%"

)

```

# roxygenlabs

> Experimental 'roxygen' Tags and Extensions

[![Linux Build Status](https://travis-ci.org/gaborcsardi/roxygenlabs.svg?branch=master)](https://travis-ci.org/gaborcsardi/roxygenlabs)

[![Windows Build status](https://ci.appveyor.com/api/projects/status/github/gaborcsardi/roxygenlabs?svg=true)](https://ci.appveyor.com/project/gaborcsardi/roxygenlabs)

[![](http://www.r-pkg.org/badges/version/roxygenlabs)](http://www.r-pkg.org/pkg/roxygenlabs)

[![CRAN RStudio mirror downloads](http://cranlogs.r-pkg.org/badges/roxygenlabs)](http://www.r-pkg.org/pkg/roxygenlabs)

Experimental 'roxygen' Tags and Extensions

## Installation

Once on CRAN, install the package with

```r

install.packages("roxygenlabs")x

```

## Usage

Currently there is no official way to load a package when running

`devtools::document()` or `roxygen2::roxygenize()`, but you can use a trick:

put the package loading code into the `Roxygen` field in `DESCRIPTION`:

```

Roxygen: { library(roxygenlabs); list(markdown = TRUE) }

```

### Conditional examples

```{r child = "man/chunks/examplesIf.Rmd"}

```

### CSS and Javascript themes

```{r child = "man/chunks/theme.Rmd"}

```

## License

MIT © RStudio