rcsb/rcsb-statistics-b

RCSB statistics overhaul

Table of Contents

1. About RCSB PDB Statistics
   • Built With
2. Roadmap
3. Getting Started
   • Prerequisites
   • Installation
4. Usage

About RCSB PDB Statistics

Visual summaries of RCSB PDB data can be used to effectively communicate complex information to a wide range of use.

What is RCSB PDB Statistics?:

• A comprehensive portfolio of statistics that effectively summarize PDB data.
• Visual summaries of RCSB PDB data allow users to identify patterns and trends that may not be immediately apparent in raw data
• Easy-to-use yet powerful tools for non-programmatic users to explore PDB data

These statistics are generated using Web Services and represent the current holdings of the archive. View statistics on PDB Data Deposited and Data Downloaded.

(back to top)

Roadmap

• RO-4108 Charting application landing page
• RO-4100 Responsive statistics application layout
• RO-4101 Expand charting area to full screen mode
• RO-4111 Chart description display
• RO-4113 Toggle between linear and logarithmic scale
• RO-4102 Filter the chart based on displayed categories
• RO-4104 Chart export functionality as image
• RO-4110 Display of chart data as table
• RO-4112 Reset all options to original state
• RO-4109 Chart data download as CSV
• RO-4199 Navigation between application states
• RO-4105 Access to Search API query editor
• RO-4106 Enable navigation to search results via chart elements
• RO-4114 Data growth charts exploration
• RO-4134 Dynamic and interactive charting area
• RO-4107 Color palette customization for accessible and publication-ready charts

See the feature list for a full list of features to be worked on.

(back to top)

Built With

Here's a list of the major frameworks/libraries used for this project.

• 
• 

(back to top)

Getting Started

This module is intented to be used within the RCSB Sierra web application. To get a local copy up and running follow these simple teps.

Prerequisites

If not installed already, you will need Node Package Manager

• npm

  npm install npm@latest -g

Installation

Let's get started

1. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

2. Install NPM packages

   npm install

3. Start the application

   npm start

4. Start the application navigate to http://localhost:3001/

(back to top)

Usage

Coming Soon. This section will have information about how to use the RCSB PDB Statistics page.

For more examples, please refer to the Documentation

(back to top)