README.md

Cite as:

Introduction

The KWB.utils package is designed to enhance the quality and safety of your R code by offering a set of utility functions. The primary objective is to streamline code development by minimizing duplication and promoting cleaner coding practices.

Key Features

• Code Cleanliness: This package focuses on helping developers create cleaner code, which is characterized by limited duplication and increased readability.
• General Utility Functions: Currently there are 335 functions defined in this package

Installation

# Enable repository from kwb-r
options(repos = c(
  kwbr = 'https://kwb-r.r-universe.dev',
  CRAN = 'https://cloud.r-project.org'))
  
# Download and install kwb.utils in R
install.packages('kwb.utils')

# Browse the kwb.swmm manual pages
help(package = 'kwb.utils')

This will install the package in the following locations based on your operating system:

• Linux: /usr/local/lib/R/site-library
• Windows: C:/Users/{Your Username}/Documents/R/win-library/{R Version}

Once the installation is complete the package may be included as a library in any future R session, just be sure to include

#library(kwb.utils)

Additional details on how to install KWB-R packages can be found in our installation tutorial.

Usage

The functions included in this package have been organized into the following categories:

• Arrays/Matrices
• Calling
• Check
• Comparing Objects
• Conversion
• Crytographic
• Debug
• For Data Frames
• For Lists
• Functions Returning Functions
• General Objects
• Grammar/Dictionary
• Input and Output
• Logical Returning
• Mathematical or Statistical
• PDF Related
• Operating Systems
• Shortcuts to If Statements
• String
• Vectors
• Miscellaneous

*This list is not exhaustive of all the functions defined in the package. Additionally, the links to documentation are currently a work in progress.

Documentation

Release: https://kwb-r.github.io/kwb.utils

Development: https://kwb-r.github.io/kwb.utils/dev

License

This project is licensed under the MIT License.