The amstools is a (mostly) NOSAMS specific package for working with AMS data and the NOSAMS database.

Installing

The package should be installed from github. You'll need the devtools package installed.

devtools::install_github("blongworth/amstools")

To interact with the NOSAMS DB, you'll need a working ODBC driver and connection for the database. The easiest way to check this is with the Rstudio Connections tab. Amstools looks for your database credentials in an environment variable called CONSTRING, which should be in the following format:

"DSN=database;UID=username;PWD=password"

The database also has to be set up as an ODBC connection.

Getting started

First, load the library.

library(amstools)

A list of functions in the package should help you get started. Most functions are tersely documented, but the functions are commented.

Some useful functions

Loading data

getWheel() loads an analysed wheel from snics_results getRawWheel() loads raw data for a wheel from snics_raw

Reporting

recReport() produces a markdown report for a rec_num



blongworth/amstools documentation built on Nov. 9, 2023, 6:52 p.m.