{"id":25138508,"url":"https://github.com/neurogenomics/templater","last_synced_at":"2025-08-21T23:26:46.686Z","repository":{"id":69000601,"uuid":"439340687","full_name":"neurogenomics/templateR","owner":"neurogenomics","description":"Self-updating template for developing R packages.","archived":false,"fork":false,"pushed_at":"2023-12-09T18:26:33.000Z","size":2381,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-30T00:12:26.062Z","etag":null,"topics":["bioconductor","cran-r","documentation","github-actions","r","r-package","templates"],"latest_commit_sha":null,"homepage":"https://neurogenomics.github.io/templateR/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/neurogenomics.png","metadata":{"files":{"readme":"README.Rmd","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2021-12-17T13:23:10.000Z","updated_at":"2024-10-14T05:14:37.000Z","dependencies_parsed_at":"2023-03-01T07:31:20.506Z","dependency_job_id":"777e4ef5-f659-4975-bcee-7add40a81151","html_url":"https://github.com/neurogenomics/templateR","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/neurogenomics/templateR","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neurogenomics%2FtemplateR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neurogenomics%2FtemplateR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neurogenomics%2FtemplateR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neurogenomics%2FtemplateR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neurogenomics","download_url":"https://codeload.github.com/neurogenomics/templateR/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neurogenomics%2FtemplateR/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271560491,"owners_count":24780865,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-21T02:00:08.990Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["bioconductor","cran-r","documentation","github-actions","r","r-package","templates"],"created_at":"2025-02-08T17:16:52.072Z","updated_at":"2025-08-21T23:26:46.674Z","avatar_url":"https://github.com/neurogenomics.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\ntitle: \"`r read.dcf('DESCRIPTION', fields = 'Package')[1]`\"  \nauthor: \"`r rworkflows::use_badges()`\" \ndate: \"\u003ch4\u003eREADME updated: \u003ci\u003e`r format( Sys.Date(), '%b-%d-%Y')`\u003c/i\u003e\u003c/h4\u003e\"\noutput:\n  github_document\n---\n\n\u003c!-- To modify Package/Title/Description/Authors fields, edit the DESCRIPTION file --\u003e\n\n```{r, echo=FALSE, include=FALSE}\npkg \u003c- read.dcf(\"DESCRIPTION\", fields = \"Package\")[1]\ntitle \u003c- gsub(\"\\n\",\" \",read.dcf(\"DESCRIPTION\", fields = \"Title\")[1])\ndescription \u003c- gsub(\"\\n\",\" \",read.dcf(\"DESCRIPTION\", fields = \"Description\")[1])\nURL \u003c- read.dcf('DESCRIPTION', fields = 'URL')[1]\nowner \u003c- strsplit(URL,\"/\")[[1]][4]\nrepo \u003c- strsplit(URL,\"/\")[[1]][5]\n```\n \n**\\\u003c---⬇️⬇️⬇️(Start of section that can be deleted after forking the template)⬇️⬇️⬇️---\\\u003e** \n\n## Citation\n\nIf you use the `templateR` R package template, \nor any of the [`rworkflows`](https://github.com/neurogenomics/rworkflows) suite tools,\nplease cite:\n\n\u003e Brian M. Schilder, Alan E. Murphy, \u0026 Nathan G. Skene (2023) The rworkflows suite: automated continuous integration for quality checking, documentation website creation, and containerised deployment of R packages, Research Square; https://doi.org/10.21203/rs.3.rs-2399015/v1\n\n## Setup\n\n`templateR` is a template designed to make developing new R packages easy by providing:  \n\n  - **DESCRIPTION, vignettes/, tests/, R/, man/, inst/**: Basic skeleton for the package itself.  \n  - **README.Rmd**: Auto-populates based on the *DESCRIPTION* file (that can be knit to create *README.md*). Also contains [badges](https://github.com/GuangchuangYu/badger) that automatically update themselves.   \n  - **inst/hex/hexSticker.Rmd**: Template for creating [hex stickers](https://github.com/GuangchuangYu/hexSticker). \n  - **.github/workflows/\\*.yml**: [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) workflow files that will automatically trigger code checks and pushing images to [DockerHub](https://hub-stage.docker.com/) every time you make a push to your GitHub repo (from [`rworkflows`](https://github.com/neurogenomics/rworkflows)).\n  - **inst/CITATION** : Allows users of your package to call `citation(\"\u003cpackageName\u003e\")`. Also used to auto-populate the *README.Rmd*.  \n  \nTo get started, simply click on the green **Use this template** button \nat the top right of the `templateR` repo. \n\n### GitHub Secrets  \n\nTo use certain features of `rworkflows`, you may need to set up one or more [GitHub Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets):  \n\n- `PAT_GITHUB` [Optional]: Can grant access to private repos on GitHub\n  Actions. You can generate your very own Personal Authentication Token\n  with `usethis::create_github_token()`. See the [GitHub\n  docs](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)\n  for details.  \n- `DOCKER_TOKEN` [Optional]: Allows GitHub Actions to push to a\n  [DockerHub](https://hub.docker.com) account.\n  \n### GitHub Pages\n\nThe [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) workflows included in this template will automatically create a documentation website for your package via [GitHub Pages](https://pages.github.com/).  \n\nAfter the **`rworkflows` action** has successfully run on Ubuntu for the \nfirst time, a new branch will appear in your repo called \"gh-pages\".   \n\n**\\\u003c---⬆️⬆️⬆️(End of section that can be deleted after forking the template)⬆️⬆️⬆️---\\\u003e** \n\n## ``r pkg``: `r gsub(\"\\n\",\"\",title)`\n\n### `r gsub(\"\\n\",\"\",description)`\n \nIf you use ``r pkg``, please cite: \n\n\u003c!-- Modify this by editing the file: inst/CITATION  --\u003e\n\u003e `r utils::citation(pkg)$textVersion`\n\n## Installation \n\n```R\nif(!require(\"BiocManager\")) install.packages(\"BiocManager\")\n\nBiocManager::install(\"`r paste(owner,repo,sep='/')`\")\nlibrary(`r pkg`)\n```\n## Documentation \n\n### [Website](https://`r owner`.github.io/`r repo`) \n### [Getting started](https://`r owner`.github.io/`r repo`/articles/`r pkg`) \n\n\u003chr\u003e\n\n## Session Info\n\n\u003cdetails\u003e\n```{r}\nutils::sessionInfo()\n```\n\u003c/details\u003e\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneurogenomics%2Ftemplater","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneurogenomics%2Ftemplater","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneurogenomics%2Ftemplater/lists"}