Description
Lightweight Utilities for 'DIZ' R Package Development.
Description
Lightweight utility functions used for the R package development infrastructure inside the data integration centers ('DIZ') to standardize and facilitate repetitive tasks such as setting up a database connection or issuing notification messages and to avoid redundancy.
README.md
DIZtools
The R package DIZtools
provides utility functions used for the R package development infrastructure inside the data integration centers (‘DIZ’) to standardize and facilitate repetitive tasks such as setting up a database connection or issuing notification messages and to avoid redundancy.
:bulb: DIZtools
contains all “lightweighted” functions of DIZutils
making it a lot quicker to install, while DIZutils
has a lot of dependencies and system requirements.
Installation
You can install DIZtools
directly from CRAN:
install.packages("DIZtools")
The development version can be installed using
install.packages("remotes")
remotes::install_github("miracum/misc-diztools", ref = "dev")
Exported functions
assign_to_R_env()
: Add variable to R environment (in contrast to system environment).check_if_unique_rows()
: Takes a data.table dataset and checks if for each unique element in a specified column there is exaclty one row.clean_path_name()
: Clean paths to surely have a tailing slash or not.clear()
: Clean the console and environment-variables.close_all_connections()
: Unset/close all open connections.dt_row_to_string()
: Get the content of a data.table row in print-ready format.equals2()
: Robust compare two elements and return true if both elements are the same. False otherwise. NoNA
orNULL
.feedback()
: Function to feedback messages either to the user and/or to the console and to the logfile.file_lines_to_list()
: Read in lines from a file and store it in a list.firstup()
: Converts the first letter of the input string to uppercase.format_POSIXct()
: Formats a given POSIXct timestamp without the need of manually specifing format parameters.get_config()
: Reads a config yaml file and return the value for a given key.get_current_timestamp()
: Quickly get the current time stamp without the need to handle format-options etc.is_date_format()
: Checks if a string matches a given date format.is.empty()
: Check for empty/NA
/NULL
/NaN
/etc. values.notin()
: notin helper function. Opposite ofin
function.number_to_position()
: Converts an integer number to its “verbal position”. 1 –> “1st”, 2 –> “2nd”, 3 –> “3rd”, 4 –> “4th”, …paste_pct_sum()
: Get the percentage of two values pretty formatted.paste2()
: Normalpaste
function with additionalcollapse_last
argument.pretty_timestamp()
: Quickly get a pretty timestamp without need to handle format-options etc.rep2()
: Repeat something with the ability to also collapse the output.robust_round()
: Round numbers without problems.setdiff_all()
: Get the difference of two vectors in both directions.setenv_file()
: Set all variables of a.env
file to the system environment.setenv2()
: Assign variables to the system environment.string_replacements()
: Clean string with a given set of replacements.time_diff_print()
: Calculate time difference of two timestamps, round the value and return a string with suiting unit.trim.space()
: Trim Spaces of a string.vgsub()
: Vectorised string replacement.
Internal functions
:bulb: Use with care. Can be used by typing DIZtools:::internal_function_name()
(<- using three :
). Not recommended.
More Infos
- about MIRACUM: https://www.miracum.org/
- about the Medical Informatics Initiative: https://www.medizininformatik-initiative.de/de/start.