tidytuesdayR (version 1.2.0)

tt_intro: Create and open intro.md

Description

When curating a TidyTuesday dataset, you need to introduce the dataset. This function creates a simple intro.md file in the specified path (creating that path if it does not already exist), and (if possible) opens it for editing.

Usage

tt_intro(
  path = "tt_submission",
  open = rlang::is_interactive(),
  ignore = FALSE
)

Value

A logical vector indicating whether the file was created or modified, invisibly.

Arguments

path

The relative path to the directory to hold your submission files (tt_submission by default). If this directory does not exist, it will be created.

open

Open the newly created file for editing? Happens in RStudio, if applicable, or via utils::file.edit() otherwise.

ignore

Should the newly created file be added to .Rbuildignore?

Examples

if (FALSE) { # interactive()

  tt_intro()
}