{"id":32200834,"url":"https://github.com/netique/buildr","last_synced_at":"2025-10-22T03:56:18.773Z","repository":{"id":45619478,"uuid":"261813233","full_name":"netique/buildr","owner":"netique","description":"Organize \u0026 Run Build Scripts Comfortably","archived":false,"fork":false,"pushed_at":"2024-04-21T07:28:52.000Z","size":4511,"stargazers_count":16,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-22T03:56:05.599Z","etag":null,"topics":["addin","buildr","cran","keyboard-shortcut","r","r-package","rpackage","rstats","rstats-package","rstudio-addin"],"latest_commit_sha":null,"homepage":"https://netique.github.io/buildr","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/netique.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.md","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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-05-06T16:12:59.000Z","updated_at":"2025-10-06T09:06:54.000Z","dependencies_parsed_at":"2024-04-21T08:43:36.405Z","dependency_job_id":"b12e70f5-9242-4baf-ac33-394f4eb91c1f","html_url":"https://github.com/netique/buildr","commit_stats":{"total_commits":62,"total_committers":3,"mean_commits":"20.666666666666668","dds":"0.29032258064516125","last_synced_commit":"039c765a4fb90049f11f12e59adea14f13f1994b"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/netique/buildr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netique%2Fbuildr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netique%2Fbuildr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netique%2Fbuildr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netique%2Fbuildr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netique","download_url":"https://codeload.github.com/netique/buildr/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netique%2Fbuildr/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280376547,"owners_count":26320275,"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-10-22T02:00:06.515Z","response_time":63,"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":["addin","buildr","cran","keyboard-shortcut","r","r-package","rpackage","rstats","rstats-package","rstudio-addin"],"created_at":"2025-10-22T03:56:17.573Z","updated_at":"2025-10-22T03:56:18.765Z","avatar_url":"https://github.com/netique.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 setup, echo = FALSE}\nknitr::opts_chunk$set(\n  echo = TRUE, eval = FALSE,\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\"\n)\n```\n\n# buildr \u003cimg src=\"man/figures/logo.png\" align=\"right\" height=\"180\"/\u003e\n\n\u003c!-- badges: start --\u003e\n\n[![CRAN](https://img.shields.io/cran/v/buildr?label=CRAN)](https://CRAN.R-project.org/package=buildr)\n[![buildr status badge](https://netique.r-universe.dev/badges/buildr)](https://netique.r-universe.dev)\n[![DESCRIPTION version)](https://img.shields.io/github/r-package/v/netique/buildr?label=devel)](https://github.com/netique/buildr)\n[![R CMD Check](https://github.com/netique/buildr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/netique/buildr/actions/workflows/R-CMD-check.yaml)\n[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/buildr)](https://cranlogs.r-pkg.org/)\n[![Lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://lifecycle.r-lib.org/articles/stages.html#maturing/)\n\n\u003c!-- badges: end --\u003e\n\n\u003e Organize \u0026 Run Build Scripts Comfortably\n\nWorking with reproducible reports or any other similar projects often requires to run the script that \"builds\" the output file in a specified way. `{buildr}` can help you organize, modify and comfortably run those scripts. The package provides a set of functions that **interactively guides you through the process** and that are available as [RStudio Addin](https://rstudio.github.io/rstudioaddins/), meaning you can set up the **keyboard shortcuts**, enabling you to choose and run the desired build script with **one keystroke anywhere anytime.**\n\n## Installation\n\nYou can install the stable version of `{buildr}` ([![CRAN](https://img.shields.io/cran/v/buildr?label=CRAN)](https://CRAN.R-project.org/package=buildr)) from [CRAN](https://CRAN.R-project.org/package=buildr) with:\n\n```{r}\ninstall.packages(\"buildr\")\n```\n\nAnd the development version ([![DESCRIPTION version)](https://img.shields.io/github/r-package/v/netique/buildr?label=devel)](https://github.com/netique/buildr)) from [GitHub](https://github.com/netique/buildr) with:\n\n```{r}\nif (!require(remotes)) {install.packages(\"remotes\")}\nremotes::install_github(\"netique/buildr\")\n```\n\n## Load the package\n\nFirst, load the package with:\n\n```{r init}\nlibrary(buildr)\n```\n\nYou can skip the step above and prepend `buildr::` to every function call. That could be handy if you use `{buildr}` functions only occasionally.\n\n## Use `{buildr}` in three steps\n\n1.  First, call `init()`, which initializes a special `Makefile` in project root with automatically discovered build scripts that share a common prefix and separator (\"build\" and \"_\", by default). `Makefile` is a standard \"recipe book\" which tells the software how it should be compiled. It's so general it can serve perfectly for our purposes. See the [documentation for GNU Make](https://www.gnu.org/software/make/manual/html_node/) or read `vignette(\"know_your_buildr\")` vignette of `{buildr}`.\n\n\n2.  If you have only one build script, you may just proceed by calling `build()`. However, **the strength of `{buildr}` lies in the ease with which you can choose the desired script and run it when your project is populated with many of them**. To do so, call `aim()` and choose among the scripts `{buildr}` discovered for you. `aim()` will set one of the `Makefile` targets to be recognized by RStudio Build pane.\n\n3.  The last step that you'll need and use most of the time is the actual \"building\". Simply call `build()` to run the first `Makefile` entry that you have previously set with `aim()`.\n\nThat's it! To learn more about `{buildr}`, `Makefile`s or other relevant stuff, please refer yourself to the `vignette(\"know_your_buildr\")` vignette, which describes how to use `{buildr}` as an Addin, **how to define your keyboard shortcut** and much more.\n\nHappy building!\n\n## License\n\nThis program is free software and you can redistribute it and or modify it under the terms of the [GNU GPL 3](https://www.gnu.org/licenses/gpl-3.0.en.html).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetique%2Fbuildr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetique%2Fbuildr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetique%2Fbuildr/lists"}