Title: Shortcuts for File Creation with Informative Prefixes
Version: 0.1.0
Description: Provides functions for quickly creating R and Python scripts, as well as 'Rmarkdown' or Quarto documents with automatically assigned name prefixes. Prefixes are either file counts (e.g. "001") or dates (e.g. "2022-09-26").
URL: https://github.com/jobrachem/organizr
BugReports: https://github.com/jobrachem/organizr/issues
License: MIT + file LICENSE
Encoding: UTF-8
RoxygenNote: 7.2.0
Imports: fs, here, readr, rlang, rstudioapi, stringr
Suggests: testthat (≥ 3.0.0)
Config/testthat/edition: 3
NeedsCompilation: no
Packaged: 2022-09-27 15:38:12 UTC; johannesbrachem
Author: Johannes Brachem ORCID iD [aut, cre]
Maintainer: Johannes Brachem <jbrachem@posteo.de>
Repository: CRAN
Date/Publication: 2022-09-29 08:50:02 UTC

Quickly create and open files with consistent prefixes.

Description

r() creates an R script.

py() creates a Python script.

rmd() creates an Rmarkdown document.

qmd() creates a Quarto document.

Usage

r(
  name,
  prefix_by = c("count", "date"),
  proj_path = here::here(),
  open = rlang::is_interactive()
)

qmd(
  name,
  prefix_by = c("count", "date"),
  proj_path = here::here(),
  open = rlang::is_interactive()
)

rmd(
  name,
  prefix_by = c("count", "date"),
  proj_path = here::here(),
  open = rlang::is_interactive()
)

py(
  name,
  prefix_by = c("count", "date"),
  proj_path = here::here(),
  open = rlang::is_interactive()
)

Arguments

name

A character string; name of the script.

prefix_by

Which prefix to use. Can be "count" or "date".

proj_path

Project path.

open

If TRUE, tries to open the file with RStudio after creation.

Details

Orgnizr allows you to set some global options. See https://github.com/jobrachem/organizr for details.

Value

The filepath as a character string.