README.md

In leppott/CASTfxn: Functions for Causal Assessment Screening Tool (CAST)

README-CASTfxn

#> Last Update: 2019-05-16 14:58:48

Suite of functions for the Causal Assessment Screening Tool (CAST).

Badges

Installation

Requires the use of devtools (or another package) to install from GitHub.

If using devtools need to add an extra line of code (see below). https://github.com/r-lib/devtools/issues/1939

Vignettes are also not installed by default. The additional parameters in install_github are used to install the vignettes.

Sys.setenv("TAR" = "internal")
devtools::install_github("leppott/CASTfxn", force=TRUE, build_vignettes=TRUE)

Purpose

Functions to aid the data analysis and drive the functionality of the Causal Assessment Screening Tool.

Status

In development.

Usage

By those using the CAST.

Documentation

Vignette and install guide are planned for the future.

Help

Every function has a help file with a working example. There is also a vignette with descriptions and examples of all functions in the CASTfxn library.

# To get help on a function
# library(CASTfxn) # the library must be loaded before accessing help
?CASTfxn

To see all available functions in the package use the command below.

# To get index of help on all functions
# library(CASTfxn) # the library must be loaded before accessing help
help(package="CASTfxn")

leppott/CASTfxn documentation built on Sept. 6, 2019, 11:04 p.m.