https://github.com/wlandau/drakeplanner

A web app to create new drake projects
https://github.com/wlandau/drakeplanner

Last synced: 16 days ago
JSON representation

A web app to create new drake projects

• Host: GitHub
• URL: https://github.com/wlandau/drakeplanner
• Owner: wlandau
• License: gpl-3.0
• Created: 2019-05-11T11:51:26.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2021-02-06T22:33:44.000Z (almost 4 years ago)
• Last Synced: 2024-08-13T07:15:04.659Z (3 months ago)
• Language: R
• Homepage: https://wlandau.shinyapps.io/drakeplanner
• Size: 616 KB
• Stars: 20
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - wlandau/drakeplanner - A web app to create new drake projects (R)

README

        
---

output: github_document

---



## Consider `targets`

`drake` is [superseded](https://www.tidyverse.org/lifecycle/#superseded). The [`targets`](https://docs.ropensci.org/targets/) R package is the long-term successor of `drake`, and it is more robust and easier to use. Please visit  for full context and advice on transitioning. The counterpart of `drakeplanner` in `targets` is `targetsketch`: .

# drakeplanner

This R/Shiny app is a companion to the [`drake`](https://github.com/ropensci/drake) R package. It helps new users learn [`drake`](https://github.com/ropensci/drake), and it helps new and experienced users set up new [`drake`](https://github.com/ropensci/drake)-powered projects. Simply provide a [`drake` plan](https://books.ropensci.org/drake/plans.html), and `drakeplanner` will show you the end-to-end dependency graph of your workflow and produce a downloadable R script to get your project started.

# Access

This app is available online at [https://wlandau.shinyapps.io/drakeplanner](https://wlandau.shinyapps.io/drakeplanner). If you cannot access it, you can install it locally in an R session.

```{r, eval = FALSE}

install.packages("remotes")

remotes::install_github("wlandau/drakeplanner")

```

Then run it on your own machine.

```{r, eval = FALSE}

drakeplanner::drakeplanner()

```

# Usage

1. Navigate to the `Plan` view (left sidebar).

2. Write your [`drake` plan](https://books.ropensci.org/drake/plans.html) in the `Plan` box. The code must return a valid `drake` plan at the end, ideally with a call to the [`drake_plan()`](https://ropensci.github.io/drake/reference/drake_plan.html) function.

3. Write your [custom functions](https://books.ropensci.org/drake/plans.html) in the `Functions` box.

4. Click `Update` button in the `Control` box.

5. Optional: click the `Download` button in the `Control` box to save your workflow as an R script.

# Tips

- For smaller graphs and faster rendering times, consider setting the `max_expand` argument of [`drake_plan()`](https://ropensci.github.io/drake/reference/drake_plan.html) to a small number for testing and debugging purposes.