Package 'sassy'

Title: Makes 'R' Easier for Everyone
Description: A meta-package that aims to make 'R' easier for everyone, especially programmers who have a background in 'SASĀ®' software. This set of packages brings many useful concepts to 'R', including data libraries, data dictionaries, formats and format catalogs, a data step, and a traceable log. The 'flagship' package is a reporting package that can output in text, rich text, 'PDF', 'HTML', and 'DOCX' file formats.
Authors: David J. Bosak
Maintainer: David Bosak <[email protected]>
License: CC0
Version: 1.2.5
Built: 2025-01-19 03:45:35 UTC
Source: https://github.com/dbosak01/sassy

Help Index


Generates an Installation Qualification Report

Description

The run_iq function executes an installation qualification (IQ) on the currently installed sassy packages, and generates a report on the results. The IQ ensures that all sassy packages have been installed. The results of the IQ will be placed in the supplied location.

Usage

run_iq(location)

Arguments

location

The path to the desired output directory. The IQ reports and any associated files will be placed in this directory.

Value

The path to the output directory. The directory will contain a PDF report showing a summary of the results of the IQ. After the function is run, review this report to ensure that all tests passed.

Examples

# Create a temp directory
tmp <- tempdir()

# Run the Installation Qualification
run_iq(tmp)

Generates an Operational Qualification Report

Description

The run_oq function executes an operational qualification (OQ) on the currently installed sassy packages and generates a report on the results. The OQ ensures that the sassy packages are installed and working as expected. The results will be placed in the supplied location.

Usage

run_oq(location)

Arguments

location

The path to the desired output directory. The IQ reports and any other associated files will be placed in this directory. Location should be specified as a directory only. The file names will be generated by the function.

Details

The Operation Qualification works by executing a representative set of functions from each sassy package, and comparing the results against expected values. Here is a brief description of the operations performed on each package:

  • logr: A sample log is produced and checked for existence. This test confirms the following functions: log_open, log_print, and log_close.

  • fmtr: The basic operations of the package are executed and compared against expected output: fapply, fdata, value, condition, write.fcat, and read.fcat.

  • libr: The procedure verifies that the fundamental operations of the package are working properly without errors: libname, lib_add, lib_remove, dictionary, and datastep.

  • reporter: The reporter package is tested by producing sample reports in each of the available output types: TXT, HTML, RTF, PDF, and DOCX. This method tests almost all of the sub-functions of the package.

  • common: The following representative functions are run and tested for errors and valid return values: v, sort, labels, roundup, Sys.path, find.names, and copy.attributes.

  • procs: All the major functions of the package are executed and tested against expected results: proc_freq, proc_means, proc_transpose, proc_sort, and proc_print.

Value

The path to the output directory. This directory will contain subdirectories with the output reports, logs, and other files produced by the Operation Qualification. At the top level, the directory will contain a PDF report showing a summary of the results of the OQ. After the function is run, review this report to ensure that all tests passed.

Examples

# Create a temp directory
tmp <- tempdir()

# Uncomment to Run the Operational Qualification
# run_oq(tmp)