Learn R Programming


output: github_document title: "vmTools"

Installation

install.packages("vmTools")

What is it?

  • Version Management Tools For Data Science Projects using R6 classes.
    • Lightweight data versioning using the file system and symbolic links
      • No database required
    • User-control of important versions with automated logs and reports
      • best - a single best folder of data/outputs
      • keep - an arbitrary number of important folders to keep
      • remove - an arbitrary number of folders staged for removal (with method to delete)

How does it work?

  • See the vignettes folder for examples of how to use the package.

When was the package updated?

  • See the NEWS file

Who wrote it? Who maintains it?

  • See the DESCRIPTION file.

The newest version doesn't work for me, how do I install an older release?

# fill in your favorite version number
devtools::install_github("epi-sam/vmTools@v0.0.0")

Code of Conduct

Please note that the vmTools project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Style Guide

Please note that the vmTools project is contains a Contribution Style Guide. By contributing to this project, you agree to read and adhere to these styles.

Copy Link

Version

Install

install.packages('vmTools')

Version

1.0.1

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Sam Byrne

Last Published

July 25th, 2025

Functions in vmTools (1.0.1)

is_windows_admin

If running on windows, check if the user has admin privileges
split_line_breaks

Split a character vector by line breaks
assert_dir_exists

Assert a directory exists on disk
dir_tree

Print a directory tree to stdout
clean_path

Wrapper utility for sanitizing file.path(...) output
assert_scalar_not_empty

Assert x is a scalar, and not empty in some way
assert_scalar

Assert an element is atomic and length 1
assert_type

Assert an object is a scalar of a certain type
assert_named_list

Assert an object is a list with named elements
SLT

SymlinkTool R6 class
find_n_cores

Cross platform helper to find number of cores
find_latest_output_dir

Find the latest output directory with format YYYY_MM_DD.VV
is_an_error

Determine if an object is an error
get_new_version_name

Increment a new output folder version as "YYYY_MM_DD.VV"
print.Symlink_Tool

Symlink Tool custom print method
is_windows

Is the current OS windows
get_latest_output_date_index

get the latest index for given an output dir and a date
lapply_depth

lapply at some list dept
validate_dir_exists

Validate whether a directory exists
validate_not_empty

Validate an object is not length 0, empty, blank etc.