https://github.com/gesistsa/usemh
generate one more readme for MH
https://github.com/gesistsa/usemh
Last synced: 3 months ago
JSON representation
generate one more readme for MH
- Host: GitHub
- URL: https://github.com/gesistsa/usemh
- Owner: gesistsa
- License: eupl-1.2
- Created: 2024-06-17T08:19:59.000Z (about 2 years ago)
- Default Branch: v0.0
- Last Pushed: 2025-05-27T13:29:11.000Z (about 1 year ago)
- Last Synced: 2026-02-09T00:35:54.966Z (4 months ago)
- Language: R
- Homepage:
- Size: 59.6 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE.md
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%"
)
```
# usemh
The goal of usemh is to ...
## Installation
You can install the development version of `usemh` like so:
``` r
## Don't install this if you don't know how to do so.
```
## Method
Hopefully, it will generate all the boilerplate files for the MH submission of your R package.
```r
library(usemh)
use_mh_method()
```
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:
1. `CITATION.cff` - [Citation File Format](https://citation-file-format.github.io/)
2. All the files for (my)Binder integration, e.g. `postBuild`, `install.R`, `apt.txt`, and `runtime.txt`, `install.R`, see the [tutorial preparation guide on this](https://github.com/GESIS-Methods-Hub/guidelines-for-tutorials). By default, these files are located in `.binder`.
3. Initialize a Quarto project (`_quarto.yml`) and `methodshub.qmd` to act as the "README" for the submission
In 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.
### Additional information
* For the initial `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.
* For `CITATION.cff`, information is collected from `inst/CITATION` (If available, otherwise generated from `DESCRIPTION`).
* This package is designed to make the boilerplate files affecting neither the existing `README.md` nor the usual `R CMD check`. All of boilerplate files added are tracked in `.RBuildignore`.
* Dig into the source code to study how to undo `usemh::use_mh_method()`.
## Tutorial
To bootstrap a tutorial
```r
use_mh_tutorial_template(title = "A Tutorial on doing everything with LLMs")
```
To add files for Binder compatibility
```r
use_mh_tutorial_utils()
```