Package 'organizr' reference manual

Title:	Shortcuts for File Creation with Informative Prefixes
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").
Authors:	Johannes Brachem [aut, cre]
Maintainer:	Johannes Brachem <[email protected]>
License:	MIT + file LICENSE
Version:	0.1.0
Built:	2025-03-04 03:32:17 UTC
Source:	https://github.com/jobrachem/organizr

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()
)
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.