createTestFraserDataSet: Create a test dataset

View source: R/example_functions.R

createTestFraserSettingsR Documentation

Create a test dataset

Description

Create a test case dataset based on the test sample annotation to be used in the vignette and to explore the functionality of the FRASER package. Dependent on the request only the sample annotation or a full fitted model is returned.

Usage

createTestFraserSettings(workingDir = "FRASER_output")

createTestFraserDataSet(
  workingDir = "FRASER_output",
  rerun = FALSE,
  metrics = "jaccard"
)

Arguments

workingDir

Directory where to store HDF5 and RDS files. Defaults to FRASER_output in the current working directory.

rerun

Defaults to FALSE. If set to TRUE it reruns the full fit of the model.

metrics

The splice metrics that should be included in the test fds. One or several of 'jaccard', 'psi5', 'psi3' or 'theta'.

Value

A FraserDataSet object that contains a test case

Examples

fds <- createTestFraserSettings()
fds

fds <- createTestFraserDataSet()
fds


c-mertes/FRASER documentation built on June 14, 2024, 7:49 p.m.