dashboard.async.run: Launch asynchronous dashboard job

View source: R/async.R

dashboard.async.runR Documentation

Launch asynchronous dashboard job

Description

Launches a job running the dashboard function in a separate system process in the background. The job is given a unique ID, which is returned by this function.

Usage

dashboard.async.run(
  ssid,
  uniprotId,
  pdbs,
  mainChains,
  wt.seq = NULL,
  seq.offset = 0,
  syn.med = NULL,
  stop.med = NULL,
  overrideCache = FALSE,
  outFormats = c("pdf", "png"),
  pngRes = 100
)

Arguments

ssid

The MaveDB ScoreSet ID of the dataset to be visualized

uniprotId

The UniprotKB accession for the corresponding protein

pdbs

A vector of PDB accessions to be used for the structure tracks

mainChains

the chain identifiers corresponding to the protein in question for each provided pdb accession.

wt.seq

An (optional) wild-type sequence for the given protein to use instead of the sequence found in UniprotKB. This can be either a nucleotide or amino acid sequence.

seq.offset

A parameter describing the start position of the map in the protein's amino acid sequence. For example, if only a domain was scanned.

syn.med

The median value of synonymous variants as an estimate of wild-type function. This is only necessary of no synonymous variants are present in the dataset.

stop.med

The median value of nonsense variants as an estimate of complete loss of function. This is only necessary if no nonsense variants are present in the dataset.

overrideCache

defaults to FALSE. If set to TRUE, data will always be re-downloaded from remote locations instead of using a local cache.

outFormats

a vector containing any of the following strings: x11, pdf, png . Using two or all three at once is allowed and will result in multiple output files.

pngRes

Resolution of PNG output in DPI. Defaults to 100.

Value

the job ID


jweile/mavevis documentation built on Oct. 30, 2023, 7:16 a.m.