CCMap: CCMap

View source: R/CCMap.R

CCMapR Documentation

CCMap

Description

Maps CCs in a specific chromosome region, alongside various annotations.

Usage

CCMap(
  in.mode = "fullmap",
  path.name = getwd(),
  exp.name,
  genome = "Cer3H4L2",
  phase = "meiosis",
  samples,
  os = 0,
  mcal = F,
  cal.path,
  chrom.,
  pos,
  window.w,
  ylims = 50,
  loci = "manual",
  smooth.mode = "none",
  Fsize = 101,
  win = 50,
  norm.factor = 3,
  gene.track = T,
  ARS.track = T,
  Ty.track = T,
  MNase.track = T,
  scc1.track = T,
  disparity = F,
  out.mode = "png",
  plotdimensions = "wide",
  featureplot = 0,
  names,
  origin.line = F,
  portrait = F,
  basic.mode = F,
  plot.scale = F,
  resolution = 400,
  loci.arrow = F,
  gene.names = "genename"
)

Arguments

in.mode

Reading in .RDS file or a folder of FullMaps? Choose "rds" or "fullmap". Defaults to "rds".

path.name

A character string defining the RDS file or folder containing FullMaps.

exp.name

Manually specify a name for the experiment.

genome

Which genome has the data been aligned to? "Cer3H4L2", "W303" or "hg19". Defaults to "Cer3H4L2".

phase

"meiosis" or "vegetative"

samples

Which samples to plot, as a vector of indexes in the DSBList.

os

Do you want to offset the Crick strand relative to the Watson strand prior to binning? Choose 3 for Top2, or 1 for Spo11. Choose 0 for no ofsetting. Defaults to 3.

chrom.

Which chromosome to plot?

pos

Which coordinate to centre plot on, in bp?

window.w

How wide a region to plot in bp?

ylims

A single number specifying the maximum limit of the y axis, for both Watson and Crick. OR "auto", to automatically define for each sample.

loci

Do you want to manually specify a region ("manual"), a specific single gene ("GENENAME"), or multiple maps centred on a types of features in the AllElementsDUB table (e.g "gene", "CEN", "ARS_consensus_sequence". For more options run CCFeatures() ). You can also provide a vector where the second element is "start", "mid", or "end", to centre the pileup on , for example, the end of a gene.

smooth.mode

This option controls whether to apply VariableX ("VX") or Hann window ("HW") smoothing to the broad overlay. Defults to no smoothing.

Fsize

Fsize for VariableX (See the documentation for VX function). Only used if smooth.mode == "VX".

win

Hanning window width. Only used if smooth.mode == "HW".

norm.factor

This can be used to scale the height of the smoothed track (works for Hann or VariableX smoothing). Defaults to 3.

gene.track

Do you want to plot the gene track? Defaults to TRUE.

out.mode

"pdf" or "png" file format for output.

featureplot

(default=0) changes plot cords to match feature for example c("TOP2","start") plots the at the start position of TOP2

origin.line

Do you want to plot a dotted line in the centre? Useful for demonstrating offset at finescale resolution.

plot.scale

Do you want to keep the overall plot dimensions constant? If so set to "fixed". Defaults to unfixed, which means that the overal height of the plot increases with more samples. This was George's solution to the overlapping label issue.

loci.arrow

Do you want to plot an arrow highlighting the centre of the plot? E.g the locus

gene.names

Do you want the gene track to be labelled with "genename" (e.g TEL1), or "sysname" (e.g YBL088C)?

plot.dimensions

Specify the plot size. Can be any size from the "A sizing" scale (e.g "A1"). However this is not implemented properly yet. Defaults to "wide", which is fine.

Author(s)

Will Gittens,George Brown


WHG1990/CCTools documentation built on June 16, 2024, 1:36 a.m.