MakeIGVSession: Make IGV session XML and sample information file

Description Usage Arguments Value Author(s) Examples

View source: R/tracktablesFunctions.R

Description

#' Creates IGV session XML and sample information file from a Samplesheet of metadata and FileSheet of file locations.

Usage

1
2
MakeIGVSession(SampleSheet, fileSheet, igvdirectory, XMLname, genomeName,
  locusName = "All", colourBy = NULL, igvParams = igvParam())

Arguments

SampleSheet

A data.frame object with metadata information for samples. First column must contain unique sample ids.

fileSheet

A data.frame of file locations. First column must contain the unique sample ids.

igvdirectory

A character of the directory to which sample metadata file is written.

XMLname

A character of the name for IGV session xml

genomeName

A character of genome for IGV (See IGV user guide for details)

locusName

A character of locus to display in igv on loading (See IGV user guide for details)

colourBy

Character defining which sample metadata to be used for colouring bigwig files

igvParams

An object of class igvParam containing display parameters for IGV. When providing a list, this list must be same length as number of samples and each element have two numeric values corresponding to minimum and maximum value to be used in setting data range. Currently only "autoscale" or a list of minimum and maximum values are accepted.

Value

A character of file location for the IGV session XML

Author(s)

Thomas Carroll

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
fileLocations <- system.file("extdata",package="tracktables")

bigwigs <- dir(fileLocations,pattern="*.bw",full.names=TRUE)

intervals <- dir(fileLocations,pattern="*.bed",full.names=TRUE)

bigWigMat <- cbind(gsub("_Example.bw","",basename(bigwigs)),
                   bigwigs)

intervalsMat <- cbind(gsub("_Peaks.bed","",basename(intervals)),
                      intervals)

fileSheet <- merge(bigWigMat,intervalsMat,all=TRUE)

fileSheet <- as.matrix(cbind(fileSheet,NA))

colnames(fileSheet) <- c("SampleName","bigwig","interval","bam")

SampleSheet <- cbind(as.vector(fileSheet[,"SampleName"]),
                     c("EBF","H3K4me3","H3K9ac","RNAPol2"),
                     c("ProB","ProB","ProB","ProB"))

colnames(SampleSheet) <- c("SampleName","Antibody","Species")
MakeIGVSession(SampleSheet,fileSheet,igvdirectory=getwd(),"Example","mm9")

Example output

[1] "169,169,169"
[1] "169,169,169"
[1] "169,169,169"
[1] "169,169,169"
[1] "/work/tmp/Example.xml"

tracktables documentation built on Nov. 8, 2020, 5:28 p.m.