MaveVis Help
Q: What is MaveVis?
A: MaveVis is a webtool for visualizing Variant Effect Maps from MaveDB as heatmaps together with conservation and protein structure information.
Q: How do I use MaveVis?
A: Go to http://vis.varianteffect.org, then
- Enter a search term in the
Score set
field. For example "BRCA1".- A list of possible matches will appear. Pick one.
- A field labeled
Uniprot Acc
will appear. If the MaveDB entry you selected already contains a link to UniprotKB, the associated Uniprot Accession will be automatically filled in. Otherwise it will be up to you to enter one.
A second field, labelledSequence Offset
will let you define if and how much the internal numbering in the MaveDB is offset from the official Uniprot sequence. - A field labeled
PDB structures
withBrowse
button will appear. Click theBrowse
button.- In the window that appears, you will find a table listing relevant PDB structures that overlap with the Variant Effect Map target sequence. In some instances, this table may take some time to load.
- Select the structures you would like to include in the visualization. Of particular interest may be the
Start
andEnd
columns in the table, as they indicate how much of the target sequence is covered in the structure. Furthermore, theInteractors
column may be of interest, as it details any protein-protein interaction partners included in the structure. - Click
OK
to confirm your selection. You will see the chose structure identifiers listed in thePDB structures
field.
- If the selected Score Set does not contain any nonsense or synonymous variants, MaveVis cannot automatically determine the appropriate range of scores on which to base the color scale. In these cases, fields for "Null-like" and "WT-like" scores will appear that allow you to customize these values.
- Once all fields have been filled in, you may click the
Visualize!
button. - After a short time a new box with the completed visualization will appear. At the bottom you will find a
Download
button, with a drop-down element, which offers different file formats: PDF document; PNG image, and SVG vector graphic.
Q: How do I interpret the output?
A: The heatmap at center of the visualization plots the protein's amino acid positions along the x-axis against all possible amino acid changes. Each cell is colored on a scale from blue via white to red, where blue represents a null-like score (i.e. complete loss-of-function), white represents a wildtype-like score (i.e. no effect), and red represents scores greater than that of the wildtype protein. Yellow cells indicate the original amino acid in the wildtype sequence. Diagonal dashes on each cell indicate either standard deviation or standard error of the shown score (depending which is reported in the original score set) scaled to the difference between null and wildtype scores; i.e. a dash the size of the entire cell indicates stdev/stderr the size of 1 wt-null unit. Uncertainty greater than 1 wt-null unit is indicated by the cell being crossed out.
Above the central heatmap is a summary bar that shows the relative frequency of each color in each column.
The orange tracks above the summary bar indicate burial in protein-protein interactions based on the PDB structures selected. These can be interpreted as amino acid residues being part of an interaction interface.
The steelblue track above that indicates the relative solvent-accessible surface area of each residue. High-solvent accessibility indicates amino acids being on the outside surface of a protein.
The next track indicates the secondary structure of the protein. Spiral patterns indicate α-helices or 310-helices, while arrows indicate β-strands.
Finally, the top track shows residue-specific evolutionary sequence conservation, according to the AMAS algorithm based on the UniRef90 sequence set.
Q: Can I access MaveVis computationally via webservice?
A: Yes, there is a set of three webservices, which work together to allow you to use MaveVis computationally: The "submit" service allows you to submit a new visualization job and will return a jobID token, which you can subsequently use to monitor its status and ultimately fetch the result; the "status" service accepts this token and returns a the job's current status and any messages that may apply; the "fetch" service finally accepts the token and a file format and returns the resulting file if the job has completed successfully. Typically, one would submit a job, and use the jobID token to poll the status service until the job is reported to have completed, before retrieving the result using the token with the fetch service.
Submit:
To use the submit method, make a POST request to http://varianteffect.com/submit.R with the following parameters:
parameter | type | required/optional | description | example |
---|---|---|---|---|
scoresetID |
Character string | required | The MaveDB scoreset URN | urn:mavedb:00000001-a-4 |
uniprot |
Character string | required | Uniprot Accession | P63279 |
pdb |
Character string | required | comma-separated list of PDB IDs | 3UIP,2PX9 |
mainChain |
Character string | required | comma-separated list of PDB chains | A,B |
overrideCache |
Boolean | optional | re-acquires all related assets | FALSE |
WT |
Character string | optional | The wildtype DNA- or protein-sequence | ATGTCGGGGTTACGA[...] |
seqOffset |
Integer | optional | The offset of the scoreset start position relative to the WT sequence | 0 |
synMed |
Numeric | optional | The median score of synonymous variants or expected WT-like score | 1.0 |
stopMed |
Numeric | optional | The median score of nonsense variants or expected null-like score | 0.0 |
outFormats |
Character string | optional | a comma-separated list of output formats to generate: pdf, png, svg | pdf,png,svg |
pngRes |
Integer | optional | The desired resolution of any PNG output, in DPI | 100 |
The submit method returns a JSON object with a single field:
field name | type | description | example |
---|---|---|---|
jobID | UUID | Universally unique identifier for the submitted job | c01f5193-0dda-48ba-ac29-bbb0296ab3cb |
Status:
To use the status method, make a POST request to http://varianteffect.com/status.R with the following parameter:
parameter | type | required/optional | description | example |
---|---|---|---|---|
jobID |
UUID | required | Universally unique identifier returned by the "submit" function | c01f5193-0dda-48ba-ac29-bbb0296ab3cb |
The status method returns a JSON object with the following fields:
field name | type | description | example |
---|---|---|---|
status | Character string | A brief status summary: "Processing", "Done", or "Error" | Processing |
log | Character string | Logger output from the running job, if applicable. | |
message | Character string | Any error message, if any has occurred |
Fetch:
To use the fetch method, make a POST request to http://varianteffect.com/fetch.R with the following parameters:
parameter | type | required/optional | description | example |
---|---|---|---|---|
jobID |
UUID | required | Universally unique identifier returned by the "submit" function | c01f5193-0dda-48ba-ac29-bbb0296ab3cb |
format |
Character string | required | The desired file format: pdf, png, or svg | png |
output |
Character string | optional | "direct" or "url". Determines whether the method directly returns the file, or just a link to where the file can be downloaded. | direct |
Depending on the choice of he "output" field, the fetch service will either directly return the contents of the PNG/PDF/SVG file (with appropriate MIME header), or will return a simple text response containing the URL where the file can be downloaded.
Q: How do I cite MaveVis and/or MaveDB?
A: TBA