dash-bio icon indicating copy to clipboard operation
dash-bio copied to clipboard

Add documentation to obtain, parse, and input data for each component

Open HammadTheOne opened this issue 4 years ago • 0 comments

With the growing number of dash-bio components, and parsers in dash-bio-utils, I think it's important to have a clear default pathway for each component for obtaining and parsing the data to be compatible with the component it is input it.

This issue proposes that additional documentation be added to each page in the docs which outlines some of the supported data-types, the parser or parsers involved in transforming the dataset, and the input datatype to the component after said parsing. An example would be added with the code involved in the process, and using a dataset retrieved from the most common source for that type of data.

Proposed Documentation Updates (WIP):

  • [ ] Molecule3dViewer - Retrieve a PDB files (local or otherwise), decode the dataset, parse with pdb_parser and styles_parser, and serve to the component (possibly including a dropdown for additional PDB files/types).
  • [ ] Speck - Add documentation on supported XYZ formats (eg. OpenBabel converted PDBs) and outline how to convert alternate formats to Speck-accepted inputs.

HammadTheOne avatar Jul 30 '21 15:07 HammadTheOne