Package 'tflow'

Title: Setup a project in the tflow style for using the targets package
Description: Has a function that sets up an R workflow in the dflow style, using targets.
Authors: Miles McBain [aut, cre], Shir Dekel [ctb], Noam Ross [aut] , Robert Flight M [ctb] (0000-0001-8141-7788)
Maintainer: Miles McBain <[email protected]>
License: MIT + file LICENSE
Version: 0.4.1
Built: 2024-08-25 04:40:58 UTC
Source: https://github.com/milesmcbain/tflow

Help Index


qmd_target

Description

Generate a target for a Quarto file

Usage

qmd_target(target_name)

Arguments

target_name

of a target to generate qmd target for.

Value

target text to the console.

Author(s)

Robert M Flight


rmd_target

Description

Generate a target for an R markdown file

Usage

rmd_target(target_name)

Arguments

target_name

of a target to generate rmd target for.

Value

target text to the console.

Author(s)

Miles McBain


use_gitignore

Description

Use a starter .gitignore

Usage

use_gitignore()

Details

Drop a starter .gitignore in the current working directory, including ignores for targets and capsule (renv).

Value

nothing, creates a file.

Author(s)

Miles McBain


use_qmd

Description

Create a Quarto file and generate target definition code.

Usage

use_qmd(target_name)

Arguments

target_name

a name for target and the generated quarto document.

Details

The generated document defaults to the "./doc" folder. This can be overridden with option 'tflow.report_dir'.

Value

the path of the file created. (invisibly)

Author(s)

Robert M Flight


use_rmd

Description

Create an RMarkdown file and generate target definition code.

Usage

use_rmd(target_name)

Arguments

target_name

a name for target and the generated R markdown document.

Details

The generated document defaults to the "./doc" folder. This can be overridden with option 'tflow.report_dir'.

Value

the path of the file created. (invisibly)

Author(s)

Miles McBain


use_tflow

Description

Setup a tflow project

Usage

use_tflow()

Details

Creates files and directories according to the tflow template.

Value

Nothing. Modifies your workspace.