https://github.com/wlandau/targetsketch

Sketch a pipeline of targets in an interactive web app
https://github.com/wlandau/targetsketch

data-science high-performance-computing pipeline r reproducibility rstats shiny targets workflow

Last synced: 14 days ago
JSON representation

Sketch a pipeline of targets in an interactive web app

• Host: GitHub
• URL: https://github.com/wlandau/targetsketch
• Owner: wlandau
• License: other
• Created: 2020-07-18T14:23:44.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-02T12:04:38.000Z (7 months ago)
• Last Synced: 2024-08-06T03:03:59.419Z (3 months ago)
• Topics: data-science, high-performance-computing, pipeline, r, reproducibility, rstats, shiny, targets, workflow
• Language: R
• Homepage: https://wlandau.shinyapps.io/targetsketch
• Size: 63.5 KB
• Stars: 17
• Watchers: 3
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.Rmd
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• jimsghstars - wlandau/targetsketch - Sketch a pipeline of targets in an interactive web app (R)

README

        
---

output: github_document

---

# targetsketch

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

# Access

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

```{r, eval = FALSE}

install.packages("remotes")

remotes::install_github("wlandau/targetsketch")

```

Then run it on your own machine.

```{r, eval = FALSE}

targetsketch::targetsketch()

```

# Usage

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

2. Write your [`_targets.R` script](https://books.ropensci.org/targets/walkthrough.html) in the `_targets.R` box. The code must return a valid list of [`tar_target()`](https://docs.ropensci.org/targets/reference/tar_target.html) objects at the end. If you want the app to analyze custom functions called in the commands of the targets, define them in the `_targets.R` box as well.  See the [`tar_script()`](https://docs.ropensci.org/targets/reference/tar_script.html) help file for more details.

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

5. If you want to download the code in the `_targets.R` box as an R script file, click the `Download` button in the `Control` box.

# Contributing

Contributions are welcome. If you plan to [file an issue](https://github.com/wlandau/targetsketch/issues/new/choose) or [submit a pull request](https://github.com/wlandau/targetsketch/pulls), please first read the [code of conduct](https://github.com/wlandau/targetsketch/blob/main/CODE_OF_CONDUCT.md) and [rules for contributing](https://github.com/wlandau/targetsketch/blob/main/CONTRIBUTING.md).