README.md

In wlandau/targetsketch: Create and Visualize Targets Pipelines

targetsketch

This R/Shiny app is a companion to the targets R package. It helps new users learn targets, and it helps new and experienced users set up new targets-powered projects. Simply provide a _targets.R script, 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. If you cannot access it, you can install it locally in an R session.

install.packages("remotes")
remotes::install_github("wlandau/targetsketch")

Then run it on your own machine.

targetsketch::targetsketch()

Usage

1. Navigate to the Pipeline view (left sidebar).
2. Write your _targets.R script in the _targets.R box. The code must return a valid list of tar_target() 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() help file for more details.
3. Click Update button in the Control box.
4. 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 or submit a pull request, please first read the code of conduct and rules for contributing.

wlandau/targetsketch documentation built on April 6, 2024, 8:35 p.m.