{"id":13858339,"url":"https://github.com/lockedata/starters","last_synced_at":"2025-07-13T23:32:00.811Z","repository":{"id":92506730,"uuid":"84833369","full_name":"lockedata/starters","owner":"lockedata","description":"R Package 📦 for initializing projects for various R activities :nut_and_bolt:","archived":false,"fork":false,"pushed_at":"2020-06-18T10:47:49.000Z","size":1460,"stargazers_count":124,"open_issues_count":25,"forks_count":16,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-11-22T16:39:23.789Z","etag":null,"topics":["developer-tools","r","r-package","reproducibility","rstats","setup","setup-tool","setuptools"],"latest_commit_sha":null,"homepage":"https://itsalocke.com/starters/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lockedata.png","metadata":{"files":{"readme":"README.Rmd","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-03-13T14:03:11.000Z","updated_at":"2024-09-29T20:40:38.000Z","dependencies_parsed_at":null,"dependency_job_id":"f6e6037b-17bd-4412-ac74-08dabc485fa7","html_url":"https://github.com/lockedata/starters","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/lockedata/starters","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lockedata%2Fstarters","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lockedata%2Fstarters/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lockedata%2Fstarters/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lockedata%2Fstarters/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lockedata","download_url":"https://codeload.github.com/lockedata/starters/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lockedata%2Fstarters/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265220757,"owners_count":23729875,"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","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":["developer-tools","r","r-package","reproducibility","rstats","setup","setup-tool","setuptools"],"created_at":"2024-08-05T03:02:04.965Z","updated_at":"2025-07-13T23:31:55.797Z","avatar_url":"https://github.com/lockedata.png","language":"R","readme":"---\noutput: github_document\n---\n\n# starters \u003cimg src=\"man/figures/logo.png\" align=\"right\" height=140/\u003e\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, echo = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"README-\"\n)\n```\n\u003c!-- badges: start --\u003e\n[![Build Status](https://travis-ci.org/lockedata/starters.svg?branch=master)](https://travis-ci.org/lockedata/starters) [![Coverage Status](https://img.shields.io/coveralls/lockedata/starters.svg)](https://coveralls.io/r/lockedata/starters?branch=master) [![Locke Data Slack](https://img.shields.io/badge/Slack-discuss-blue.svg?logo=slack\u0026longCache=true\u0026style=flat)](https://join.slack.com/t/lockedata/shared_invite/enQtMjkwNjY3ODkwMzg2LTI1OGU1NTM3ZGIyZGFiNTdlODI3MzU2N2ZlNDczMjM4M2U2OWVmNDMzZTQ1ZGNlZDQ3MGM2MGVjMjI2MWIyMjI)\n[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)\n\u003c!-- badges: end --\u003e\n\nThis package is designed to take away some grunt work around setting up new projects.\n\nAll projects get setup with Git, GitHub and Travis by default.\n\n- Use `create_package_project()` to setup a project with code coverage, vignettes, unit testing etc. out of the box\n\n- Use `create_analysis_project()` to get a project ready for a typical analysis project. It includes [renv](https://rstudio.github.io/renv/articles/renv.html) to help with reproducibility.\n\n- Use `create_training_project()` to get a project ready for delivering training that often involves handouts and presentation materials. It includes [renv](https://rstudio.github.io/renv/articles/renv.html) to help with reproducibility.\n\nAll functions implement name validation based on the guidance in [\"Writing R Extensions\"](https://cran.r-project.org/doc/manuals/r-release/R-exts.html#The-DESCRIPTION-file), \"[The name] should contain only (ASCII) letters, numbers and dot, have at least two characters and start with a letter and not end in a dot\".\n\n## Setup for `starters`\n\n### Installation\n\n```\nremotes::install_github(\"lockedata/starters\")\n```\n\n### `start_here()` function\n\nRun\n\n```r\nstarters::start_here()\n```\n\nThis function checks different aspects of your setup (git installation, gitconfig, `GITHUB_PAT`, `DESCRIPTION` default values, GitHub username guessing), that will help automatic steps later on. Most of these aspects are inspired from [`usethis` setup article](https://usethis.r-lib.org/articles/articles/usethis-setup.html). For each aspect, if your setup needs improvements an informative error message will be thrown so you might be able to know how to proceed.\n\n## RStudio gadget\nIf you want to set up a project without using the R functions, [\\@jonmcalder](https://github.com/jonmcalder) made a nifty [RStudio addin](https://rstudio.github.io/rstudioaddins/). Install the package to get it added to your RStudio instance.\n\n## Related work\n\n```{r child='man/rmdfragments/related-work.Rmd'} \n```\n\n## Contributing\n\n### General info\n\nWanna report a bug or suggest a feature? Great stuff! For more information on how to contribute check out [our contributing guide](.github/CONTRIBUTING.md). \n\nPlease note that this R package is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this package project you agree to abide by its terms.\n \n### Up for grabs\n\nMake sure to check out the [Issues tab in GitHub](https://github.com/lockedata/starters/issues)! We're making this project a great place to start contributing to R packages. We will help you through the process. \n","funding_links":[],"categories":["R"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flockedata%2Fstarters","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flockedata%2Fstarters","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flockedata%2Fstarters/lists"}