LoadExcel: Load Excel

View source: R/seqNdisplayR.R

LoadExcelR Documentation

Load Excel

Description

Load Excel Template in a format that fits to seqNdisplayR (see documentation or examples for details)

Usage

LoadExcel(xl_fname, load_annotations = FALSE)

Arguments

xl_fname

excel template file including path

load_annotations

load annotations (paths in ANNOTATIONS sheet in excel template) as GRanges? default=FALSE.

Details

Load Excel template and parses information to seqNdisplayR session object. See examples of the format of Excel Templates in ExamplesSampleSheetsFolder() for more information.

Value

seqNdisplayRSession object, essentially a named list with slots samples, colors, bigwig_dirs, bigwigs, parameters and annotations and optional arguments to be fed into seqNdisplay function

Author(s)

MS/SLA

Examples

#' # EXAMPLE 1:
xl_fname = system.file('extdata', 'seqNdisplayR_sample_sheet_elaborate2.xlsx', package='seqNdisplayR')
session = LoadExcel(xl_fname, load_annotations = TRUE)
plot(session, feature='LMO4')

# EXAMPLE 2:
example_folder = ExamplesSampleSheetsFolder()
xl_fname = paste0(example_folder, 'seqNdisplayR_sample_sheet_elaborate2.xlsx')
session = LoadExcel(xl_fname, load_annotations = TRUE)
plot(session, feature='LMO4')


THJlab/seqNdisplayR documentation built on Nov. 13, 2024, 10:36 a.m.