getScalpelStep1 {scalpel}

Read in results from Step 1 of SCALPEL.

Description

This step allows the user to retrieve the object of class scalpelStep1 for results from a previous session.

Usage

getScalpelStep1(outputFolder, version = NULL)

Arguments

outputFolder

The existing directory where the results that the user wishes to use are saved.

version

The 5-digit folder ID for the results that the user wishes to load. If NULL, automatically chooses the only version in outputFolder and if more than one version exists, returns an error.

Value

An object of class scalpelStep1, which can be used to run SCALPEL Step 2 using scalpelStep2 or can be used with the plotting function plotCandidateFrame.

See Also

scalpelStep1, scalpel

Examples

## Not run: 
### many of the functions in this package are interconnected so the
### easiest way to learn to use the package is by working through the vignette,
### which is available at ajpete.com/software

#assumes you have run the example for the "scalpel" function
#folder where results were saved
outputFolder = "scalpelResults"

#read previous results in
out = getScalpelStep1(outputFolder = outputFolder)
#note: if Step 1 has been run more than once, will need to specify 'version'

## End(Not run)