The goal of usemh is to …
You can install the development version of usemh
like so:
## Don't install this if you don't know how to do so.
Hopefully, it will generate all the boilerplate files for the MH submission.
library(usemh)
use_mh()
By default, it will open up the file methodshub.qmd
automatically (use
use_mh(open = FALSE)
otherwise). Under the hood, use_mh()
generates
all the boilerplate files, namely:
CITATION.cff
- Citation File
FormatpostBuild
,
install.R
, apt.txt
, and runtime.txt
, install.R
, see the
tutorial preparation guide on
this._quarto.yml
) and methodshub.qmd
to
act as the “README” for the submissionIn general, if the R package is already on CRAN, editing
methodshub.qmd
suffices. However, if your package has additional
system dependencies, you might need to edit apt.txt
to add the
additional ubuntu packages. Similarly, if the rendering of
methodshub.qmd
needs further R packages, add them in install.R
.
When submitting the R package to MH, please put methodshub.qmd
in the
“File” field of the submission form.
methodshub.qmd
, information is collected from
DESCRIPTION
. Don’t ask me / us the why question about those
headings in methodshub.qmd
for an existing CRAN package.CITATION.cff
, information is collected from inst/CITATION
(If available, otherwise generated from DESCRIPTION
).README.md
nor the usual R CMD check
. All of
boilerplate files added are tracked in .RBuildignore
.usemh::use_mh()
.