https://github.com/comet-ml/rd2md
A converter to transform R docs into markdown
https://github.com/comet-ml/rd2md
Last synced: 2 months ago
JSON representation
A converter to transform R docs into markdown
- Host: GitHub
- URL: https://github.com/comet-ml/rd2md
- Owner: comet-ml
- License: apache-2.0
- Created: 2023-11-07T13:54:16.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-11T14:16:30.000Z (over 2 years ago)
- Last Synced: 2025-04-03T02:54:46.584Z (about 1 year ago)
- Language: Python
- Size: 17.6 KB
- Stars: 3
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rd2md
A converter to transform R doc files (.Rd) into markdown files (.md).
## Installation
```shell
pip install rd2md
```
## Usage
In the following command-line examples you can use `rd2md` or `python -m rd2md`.
```shell
rd2md [RD-DIRECTORY] [MD-DIRECTORY] BASE-FILENAME-1 BASE-FILENAME-2 ...
```
where:
* [RD-DIRECTORY] is the directory of .Rd files (eg, `R/man`)
* [MD-DIRECTORY] is the output directory for markdown files
* BASE-FILENAME is the name of an Rd file without the directory or extension
## Example
To use `R/man` as the directory of Rd files, and `documentation` as
the output directory, converting `R/man/create_experiment.Rd` to
`documentation/create_experiment.md` and
`R/man/Experiment.Rd` to `documentation/Experiment.md` do this:
```shell
rd2md R/man documentation create_experiment Experiment
```