r2shortcode: Shorten Function Names of Functions in Another Package and Create an Index to Make Them Accessible

Description

When creating a package, authors may sometimes struggle with coming up with easy and straightforward function names, and at the same time hoping that other packages do not already have the same function names. In trying to meet this goal, sometimes, function names are not descriptive enough and may confuse the potential users. The purpose of this package is to serve as a package function short form generator and also provide shorthand names for other functions. Having this package will entice authors to create long function names without the fear of users not wanting to use their packages because of the long names. In a way, everyone wins - the authors can use long descriptive function names, and the users can use this package to make short functions names while still using the package in question.

See Also

Useful links:

• https://github.com/oobianom/r2shortcode

• Report bugs at https://github.com/oobianom/r2shortcode

Short algorithm to choose a short name based on a given long name

Description

A very simple and short algorithm to choose a short name based on a given name

Usage

chooseShortName(
  fullname = stop("Invalid string name entered."),
  withPrefix = NULL,
  withSuffix = NULL,
  envir = NULL,
  silent = FALSE
)

Arguments

Value

Short forms of functions

Examples

long_function_name <- 'longFunctionCall'
short_function_name <- chooseShortName(long_function_name)
short_function_name # the result should "lFC"

Clears previously stored names

Description

Beware that by clearing all stored names, you may inadventently duplicate new shortnames

Usage

clearStoredNames(w = "all")

Arguments

Value

empty stores for chosen name

Examples

nametostore = "ujuo"
storeChosenName(nametostore) #store the chosen name
nameAlreadyExists(nametostore) #check if the chosen name now exists in store
clearStoredNames("all") #clear storage of all names
nameAlreadyExists(nametostore) #check if the chosen name now exists in store, it should not

Discard shortcodes

Description

This will discard all shorthand functions created and delete them from stores as well. Good if you inadvertently shorthand a package.

Usage

discardShortcodes(
  pkg,
  reflib = options()$.funCNamesPkgReference,
  response = TRUE
)

Arguments

Value

unloads short function names

Examples

pkgName = 'quickcode'
shortenPkg(pkgName)
discardShortcodes(pkgName)

Does string have special characters?

Description

Evaluates if a specified string contains special characters

Usage

hasSpecialCharacters(string)

Arguments

Value

TRUE or FALSE

Examples

strToTest1 <- 'obi_%_good_^you'
strToTest2 <- 'obigoodyou'
hasSpecialCharacters(strToTest1)
hasSpecialCharacters(strToTest2)

Contains uppercase?

Description

Simply change if there is any uppercase letter in a string

Usage

hasUpperCase(string)

Arguments

Value

TRUE or FALSE if the string has an upper case letter

Examples

strToTest1 <- 'obiWentToSchool'
strToTest2 <- 'obiwenttoschool'
hasUpperCase(strToTest1)
hasUpperCase(strToTest2)

Help for all functions

Description

Access help for all functions including any newly created shorthand functions

Usage

help(functionName, package = NULL)

Arguments

Value

Documentation for function

Examples

pkgname <- 'qpdf' #pacakge name
shortenPkg(pkgname,TRUE) #shorten the package
index(pkgname) #index the package functions shortened
help('qpd.pl') #choose a function name and find help

Index a shortened package

Description

This function will provide you the list of shorthand functions created for a package

Usage

index(pkg = stop("Enter a package name to index"))

Arguments

Value

List of long and short forms of particular functions

Examples

if(interactive()){
pkgname <- 'qpdf'
shortenPkg(pkgname,TRUE)
index(pkgname)
}

Is string uppercase?

Description

Simply, test if a string is uppercase and return TRUE or FALSE

Usage

isUpperCase(string)

Arguments

Value

TRUE or FALSE if the string is all upper case

Examples

strTest1 <- 'OBI'
strTest2 <- 'obiO'
isUpperCase(strTest1)
isUpperCase(strTest2)

Does name already exist in memory?

Description

Evaluates if a name has already been saved by the r2shortcode. Keep in mind that if you previously used the clear function, previously saved names will be cleared

Usage

nameAlreadyExists(name)

Arguments

Value

TRUE or FALSE

Examples

nameToCheck <- 'Obinna'
nameAlreadyExists(nameToCheck)

Search for the existence of a name and save if unavailable

Description

Carries out a search on the already used shorthand function names and if the new name does not exist, it saves it

Usage

searchNameSaveName(withPrefix = NULL, strN.complete, withSuffix = NULL)

Arguments

Value

Concatenate of search and a boolean

Examples

nameToCheck <- 'ObiObianom'
searchNameSaveName(strN.complete= nameToCheck)
searchNameSaveName(strN.complete= nameToCheck)

Shorten the package

Description

This will create shorthand functions for functions in a package. This function brings together most functions in this package.

Usage

shortenPkg(pkg, addPrefix = TRUE, silent = FALSE, num.prefix = 3)

Arguments

Value

short function names for all the functions in the package

Examples

pkg <- 'qpdf'
shortenPkg(pkg,FALSE,TRUE)

Store chosen name in memory

Description

When all else passes, store this particular name in memory

Usage

storeChosenName(name)

Arguments

Value

store the chosen name in storage variable

Examples

nameStore <- 'ObiStore1'
storeChosenName(nameStore)

Help for all functions

Description

Access help for all functions including any newly created shorthand functions

Usage

whatis(functionName, package = NULL)

Arguments

Value

help for the particular function

Examples

pkgname <- 'qpdf' #pacakge name
shortenPkg(pkgname,TRUE) #shorten the package
index(pkgname) #index the package functions shortened
whatis('qpd.pl') #choose a function name and find help