load_checks: Load and parse checks in a yaml file, and return a list of...

In OuhscBbmc/trawler: Inspect a dataset

Load and parse checks in a yaml file, and return a list of useful objects.

Description

Load and parse checks in a yaml file, and return a list of useful objects.

Usage

load_checks(path_checks, origin)

Arguments

path_checks	The file path to the yaml file specifying the smells and rules. Required.
origin	The origin of the dataset. Currently supports "csv" and "REDCap". Required.

Examples

# Step 0: define paths.
#   So this package example executes on every machine, temp files are used.

# Replace the two paths for your specific project
path_checks  <- system.file("checks/checks-biochemical.yml", package = "trawler")

# Step 1: load the check definitions and the dataset to test
load_checks(path_checks, origin = "REDCap")

OuhscBbmc/trawler documentation built on Oct. 8, 2024, 11:44 p.m.