pdb-redo

v0.1.0

Published

2 years ago

The PDB_REDO component shows the change in geometric quality and fit to the experimental data between original PDB entry and its re-refined and rebuilt PDB_REDO counterpart. It is a PDB Component developed using AngularJS.

Downloads

0High
0Medium
0Low

mandarsd

BioJS PDB component PDB_REDO PDBe AngularJS

PDB Redo

The PDB_REDO component shows the change in geometric quality (a combined score for Ramachandran plot, side-chain rotamer, and atomic packing quality) and fit to the experimental data between original PDB entry and its re-refined and rebuilt PDB_REDO counterpart.

It is a PDB Component Library component.

PDB_REDO

Getting Started

It takes only 3 easy steps to get started with PDB Components.

Include module files and required dependencies
Install the component
Use component as custom element anywhere in the page

If you have installed the PDB Component Library in your application then you can directly start using the component as custom element (refer step 3).

1. Include module files and dependencies

Download the module javascript and stylesheet files (pdb.redo.min.js and pdb.redo.min.css) stored in the 'build' folder. Include the files in your page <head> section.

You'll also need to include the AngularJS library file (please refer 'bower.json' file for complete dependency details).

<!-- AngularJs dependency scripts (these can be skipped if already included in page) -->
<script src="bower_components/angular/angular.min.js"></script>

<!-- minified component CSS and script -->
<link rel="stylesheet" href="build/pdb.redo.min.css" />
<script src="build/pdb.redo.min.js"></script>

2. Installation

As soon as you've got the dependencies and library files included in your application page you just need to include following installation script :

I) If you are developing an AngularJs Application

<script>
angular.module('myModule', ['pdb.redo']);
</script>

II) For other Applications

<script>
(function () {
  'use strict';
  angular.element(document).ready(function () {
      angular.bootstrap(document, ['pdb.redo']);
  });
}());
</script>

3. Using component as custom element anywhere in the page

The component can be used as custom element, attribute or class anywhere in the page.

<!-- component as custom element -->
<pdb-redo pdb-id="1cbs"></pdb-redo>

<!-- component as attribute -->
<div pdb-redo pdb-id="1cbs"></div>

<!-- component as class -->
<div class="pdb-redo" pdb-id="1cbs"></div>

Documentation

Attributes

| Sr. No. | Attribute | Values | Description | |:-------------:|:-------------|:-----|:-----| | 1 |pdb-id | PDB ID_ Mandatory attribute! | Example : pdb-id="1cbs" | | 2 | heading-text |String (Optional Attribute)Default : 'PDB_REDO model quality changes' |Example : heading-text="PDB_REDO Component"If set blank (heading-text="") it removes the heading. | | 3 | subheading-text | String (Optional Attribute)Default : '' (blank) |It can be used to add explanatory details between heading and sliders Example : subheading-text="The sliders below show the change in.." | | 4 | error-text | String (Optional Attribute)Default : 'Error:'(internal error) |Example : error-text="Error loading PDB_REDO" If set blank (error-text="") it shows no message on error. |

Custom Events

Use this to subscript/bind events of this component. Event data (available in key = 'eventData') contains information about the residue number, chain, entry and entity, etc.

| Sr. No. | Event | Description | |:-------------:|:-------------|:-----| | 1 | PDB.pdbRedo.loaded | use this event to confirm whether the component is loaded Example: document.addEventListener('PDB.pdbRedo.loaded', function(e){ //do something on event }) | | 2 | PDB.pdbRedo.api.loaded | use this event to confirm whether the component API response is received Example: document.addEventListener('PDB.pdbRedo.api.loaded', function(e){ //do something on event }) | | 3 | PDB.pdbRedo.failed | use this event to check component loading failure Example: document.addEventListener('PDB.pdbRedo.failed', function(e){ //do something on event }) |

Please refer this link for more documentation, demo and parameters details.

Contact

Please use github to report bugs, discuss potential new features or ask questions in general. Also you can contact us here for support, feedback or to report any issues.

License

The plugin is released under the Apache License Version 2.0. You can find out more about it at http://www.apache.org/licenses/LICENSE-2.0 or within the license file of the repository.

If you are interested in this plugin...

...you might also want to have a look at the PDB Component Library.

"# pdb-redo"