https://github.com/elipousson/roxygen2path

A R package for building documentation from a script or directory
https://github.com/elipousson/roxygen2path

roxygen2 rstats

Last synced: 18 days ago
JSON representation

A R package for building documentation from a script or directory

• Host: GitHub
• URL: https://github.com/elipousson/roxygen2path
• Owner: elipousson
• License: other
• Created: 2024-02-25T08:14:30.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-26T22:18:48.000Z (over 2 years ago)
• Last Synced: 2025-02-28T11:28:53.666Z (over 1 year ago)
• Topics: roxygen2, rstats
• Language: R
• Homepage: https://elipousson.github.io/roxygen2path/
• Size: 3.75 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

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%"

)

```

# roxygen2path

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)

The goal of roxygen2path is to make it easy to document scripts with {roxygen2} style documentation and then render and load that documentation by creating a mock package.

## Installation

You can install the development version of `{roxygen2path}` like so:

``` r

# pak::pkg_install("elipousson/roxygen2path")

```

The package suggests my fork of the `{sinew}` package:

``` r

# pak::pkg_install("elipousson/sinew")

```

## Related packages

This package is significantly inspired by the [document package](https://gitlab.com/fvafrcu/document).