writepackagedesc: writepackagedesc adds a packages R file to the R directory

In haddonm/codeutils: Contains a Series of Utility Functions for File Handling and Programming

writepackagedesc adds a packages R file to the R directory

Description

writepackagedesc is only used when creating a new package from GitHub, as described in ALSimGuide. It must be used when the working directory (as in getwd()) is the base directory of the incipient package. Either this functions two arguments are filled or there needs to be a basic readme.md file created by GitHub from teh package name and the brief description given inside GitHub when creating the repository.

Usage

writepackagedesc(packname = "", packdesc = "")

Arguments

packname	a character vector of the package's name, default = ”
packdesc	a brief description of what the package does, default = ”

Value

nothing but it does write a function into the R directory, creating the directory if it does not already exist.

Examples

# syntax = writepackagedesc(packname="ALSim",packdesc="")

haddonm/codeutils documentation built on April 5, 2025, 11:29 p.m.