Description Usage Arguments Value See Also Examples
View source: R/SCALPEL_helper.R
This step allows the user to retrieve the object of class scalpelStep2
for results from a previous session.
1 | getScalpelStep2(outputFolder, version = NULL, cutoff = 0.18, omega = 0.2)
|
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. |
cutoff |
A value in [0,1] indicating the dendrogram cutpoint used. The default value is 0.18. |
omega |
A value in [0,1] indicating the dissimilarity metric weight used for clustering. The default value is 0.2. |
An object of class scalpelStep2
, which can be used to run SCALPEL Step 3 using scalpelStep3
or can be used with the plotting functions plotCluster
and plotSpatial
.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | ## 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
#simplest example with default parameters:
out = getScalpelStep2(outputFolder = outputFolder)
#note: if Step 1 has been run more than once, will need to specify 'version'
#example with optional parameters:
#need to enter if non-default options were used
out = getScalpelStep2(outputFolder = outputFolder, omega = 0.2, cutoff = 0.18)
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.