| Title: | Setup a project in the dflow style for using the drake |
|---|---|
| Description: | Has a function that sets up an R workflow in the dflow style, using drake. |
| Authors: | Miles McBain [aut, cre] |
| Maintainer: | Miles McBain <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.0.0.9000 |
| Built: | 2024-08-18 05:34:20 UTC |
| Source: | https://github.com/milesmcbain/dflow |
Generate a target for an R markdown file
rmd_target(file_path)rmd_target(file_path)
file_path |
a file to generate target text for. |
target text to the console.
Miles McBain
Setup a dflow project
use_dflow()use_dflow()
Creates files and directories according to the dflow template.
Nothing. Modifies your workspace.
Use a starter .gitignore
use_gitignore()use_gitignore()
Drop a starter .gitignore in the current working directory, including ignores for drake and capsule (renv).
nothing, creates a file.
Miles McBain
Create an RMarkdown file and generate target definition code.
use_rmd(target_file)use_rmd(target_file)
target_file |
a filename for the generated R markdown document. |
The generated document defaults to the "./doc" folder. This can be overridden with option 'dflow.report_dir'.
Due to the way RMarkdown and Knitr use relative paths to the source document it can be messy to properly tag the input and output documents for an Rmd target. This function will generate a multi-expression target using 'drake::target()' that uses a clean and simple way to mark these up for drake.
The contents of the 'file_out()' call my need to be modified depending on the output file extension and path configured in the Rmd and call to 'render()'.
the path of the file created. (invisibly)
Miles McBain