add_pkg_file: Add package file

In thisutils: Collection of Utility Functions for Data Analysis and Computing

Add package file

Description

Automatically generate a file containing functions and related code for R package development.

Usage

add_pkg_file(
  desc_file = "DESCRIPTION",
  pkg_name = NULL,
  title = NULL,
  pkg_description = NULL,
  author_name = NULL,
  author_email = NULL,
  github_url = NULL,
  output_dir = "R",
  use_figlet = TRUE,
  figlet_font = "Slant",
  colors = c("red", "yellow", "green", "magenta", "cyan", "yellow", "green", "white",
    "magenta", "cyan"),
  unicode = TRUE,
  verbose = TRUE
)

Arguments

desc_file	The DESCRIPTION file. Default is "DESCRIPTION", it will be used to extract package information. Using add_pkg_file() will automatically use the DESCRIPTION file in the current directory and create ⁠<pkg_name>-package.R⁠ in the "R" directory. If you want to use some specific information, such as author_name or author_email, you can provide them manually.
pkg_name	Character string, the name of the package. Default is NULL, which will be read from DESCRIPTION file.
title	Character string, title of the package. Default is NULL, which will be read from DESCRIPTION file.
pkg_description	Character string, short description of the package. Default is NULL, which will be read from DESCRIPTION file.
author_name	Character string, name of the package author. Default is NULL, which will be read from DESCRIPTION file.
author_email	Character string, email of the package author. Default is NULL, which will be read from DESCRIPTION file.
github_url	Character string, GitHub URL of the package. Default is NULL, which will be read from DESCRIPTION file or constructed based on package name.
output_dir	Character string, directory where to save the package file. Default is "R".
use_figlet	Whether to use figlet for ASCII art generation. Default is TRUE. Details see figlet.
figlet_font	Character string, figlet font to use. Default is "Slant".
colors	Character vector, colors to use for the logo elements.
unicode	Whether to use Unicode symbols. Default is TRUE.
verbose	Whether to print progress messages. Default is TRUE.

Value

Creates a file in specified output directory.

thisutils documentation built on Sept. 11, 2025, 5:12 p.m.