{"id":27879384,"url":"https://github.com/gesistsa/usemh","last_synced_at":"2026-03-08T07:33:11.741Z","repository":{"id":244814333,"uuid":"816191948","full_name":"gesistsa/usemh","owner":"gesistsa","description":"generate one more readme for MH","archived":false,"fork":false,"pushed_at":"2025-05-27T13:29:11.000Z","size":61,"stargazers_count":1,"open_issues_count":4,"forks_count":1,"subscribers_count":2,"default_branch":"v0.0","last_synced_at":"2026-02-09T00:35:54.966Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"eupl-1.2","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gesistsa.png","metadata":{"files":{"readme":"README.Rmd","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-06-17T08:19:59.000Z","updated_at":"2025-05-27T13:29:15.000Z","dependencies_parsed_at":"2024-06-19T21:06:00.225Z","dependency_job_id":"eaf13758-625b-4e19-8bc9-2755efde3774","html_url":"https://github.com/gesistsa/usemh","commit_stats":null,"previous_names":["gesistsa/usemh"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gesistsa/usemh","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesistsa%2Fusemh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesistsa%2Fusemh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesistsa%2Fusemh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesistsa%2Fusemh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gesistsa","download_url":"https://codeload.github.com/gesistsa/usemh/tar.gz/refs/heads/v0.0","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gesistsa%2Fusemh/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30248950,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-08T05:41:50.788Z","status":"ssl_error","status_checked_at":"2026-03-08T05:41:39.075Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-05T03:21:19.614Z","updated_at":"2026-03-08T07:33:11.727Z","avatar_url":"https://github.com/gesistsa.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\"\n)\n```\n\n# usemh\n\n\u003c!-- badges: start --\u003e\n\u003c!-- badges: end --\u003e\n\nThe goal of usemh is to ...\n\n## Installation\n\nYou can install the development version of `usemh` like so:\n\n``` r\n## Don't install this if you don't know how to do so.\n```\n\n## Method\n\nHopefully, it will generate all the boilerplate files for the MH submission of your R package.\n\n```r\nlibrary(usemh)\nuse_mh_method()\n```\n\nBy 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:\n\n1. `CITATION.cff` - [Citation File Format](https://citation-file-format.github.io/)\n2. 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`.\n3. Initialize a Quarto project (`_quarto.yml`) and `methodshub.qmd` to act as the \"README\" for the submission\n\nIn 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`.\n\nWhen submitting the R package to MH, please put `methodshub.qmd` in the \"File\" field of the submission form.\n\n### Additional information\n\n* 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.\n* For `CITATION.cff`, information is collected from `inst/CITATION` (If available, otherwise generated from `DESCRIPTION`).\n* 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`.\n* Dig into the source code to study how to undo `usemh::use_mh_method()`.\n\n## Tutorial\n\nTo bootstrap a tutorial\n\n```r\nuse_mh_tutorial_template(title = \"A Tutorial on doing everything with LLMs\")\n```\n\nTo add files for Binder compatibility\n\n```r\nuse_mh_tutorial_utils()\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgesistsa%2Fusemh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgesistsa%2Fusemh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgesistsa%2Fusemh/lists"}