https://github.com/josherrickson/marp
Makefile for R Package development
https://github.com/josherrickson/marp
makefile r r-packages
Last synced: 7 months ago
JSON representation
Makefile for R Package development
- Host: GitHub
- URL: https://github.com/josherrickson/marp
- Owner: josherrickson
- Created: 2023-10-22T11:00:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-23T09:20:53.000Z (almost 2 years ago)
- Last Synced: 2025-01-29T18:11:21.384Z (8 months ago)
- Topics: makefile, r, r-packages
- Language: Makefile
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
Awesome Lists containing this project
README
## MaRP
MaRP is a **Ma**kefile for **R** **P**ackage development with a focus on
minimalism and reducing dependencies. If you have an especially complex package,
[other tools](#comparison-to-similar-tools) may be better.
While MaRP is designed to work out of the box, but is really supposed to just be
a starting point for a package's development. It has a number of Makefile rules
disabled which you can uncomment out as needed.
MaRP is based heavily on the
[Makefile](https://github.com/yihui/knitr/blob/b5583696976d12ad7aa951c8c0916b6a3f56ce93/Makefile)
for the [**knitr**](https://yihui.org/knitr/) package by Yihui Xie.
### Features
The following Make rules are supported:
- `all`: Runs a check, cleaning up artifacts afterwards.
- `deps`: Install package dependencies. The `DEP_FIELDS` variable in the
Makefile can be customized to determine which fields in DESCRIPTION are looked
at; the default is Depends and Imports.
- `document`: Run [**roxygen2**](https://roxygen2.r-lib.org).
- `build`: Build the package, without the manual (to save time). Useful for
internal testing.
- `build-cran`: Build the package including the manual. The manual is needed for
full checking and submission to CRAN.
- `test`: Run [**tinytest**](https://github.com/markvanderloo/tinytest) or
[**testthat**](https://testthat.r-lib.org) depending on which your package
uses. (Technically it will run both if you have both for some reason.) I
recommend **tinytest** due to its lack of dependencies.
- `install`: Build (if necessary) and install the package locally.
- `check`: Build (if necessary) and perform a CRAN check on the package. Note
that unlike `make all`, this does not clean up artifacts.
- `vignettes`: NYI, will eventually build just the vignettes.
- `clean`: Remove artifacts from the checking/building process.
There are also several optional rules that can be enabled by uncommenting:
- `coverage`: Runs [**covr**](https://covr.r-lib.org) against the package.
- `goodpractice`: Run
[**goodpractice**](http://mangothecat.github.io/goodpractice/) against the
package.
- `check_win`, `check_win_old`, `check_win_dev`: NYI, will eventually submit the
package to the [win-builder](https://win-builder.r-project.org) for checking.
Useful specifically for testing on the previous version or the development
version of R without installing multiple versions of R locally.
### Usage
Copy `Makefile` into the main directory for your package (the one where
DESCRIPTION lives). No modification of the file is required for simple packages.
Rules can be exectued by calling `make` followed by the rule. For example, to
build documentation, call `make document` from the main package directory.
### Comparison to similar tools
[**devtools**](https://devtools.r-lib.org/) is an R package. It introduces a
tremendous amonut of
[dependencies](https://cran.r-project.org/web/packages/pacs/vignettes/tinyverse.html):
[](https://CRAN.R-project.org/package=devtools).
[maker](https://github.com/ComputationalProteomicsUnit/maker) is a
Makefile-based approach but much heavier. For more advanced package usage, this
is a better option than MaRP.