As a primary driver of research, proper understanding of projects and investigations is crucial to focus resources, determine new opportunities, and align new projects with the needs of the scientific community.
By visualising everything from trends in topics and authorship to seeing where on the Earth contributions come from, the SHARE Analytics Dashboard provides powerful insight to instituitions about the publications, projects, data and preprints that their research team produces.
The SHARE Analytics Dashboard is a flexible extensible framework tightly integrated with the SHARE platform that provides open and collaborative tools to guide science into the future.
The SHARE Analytics Dashboard is currently in development. A testing server is available for rudimentary exploration of the possibilities available, though bear in mind that the state of code is in flux and may not be stable.
To sign up for updates about when new versions are released follow this repository and new fixes, features and releases will be emailed right to your inbox.
Pressing the Plus button at the bottom of the dashboard will append a new widget onto the dashboard.
pressing the X button in the top right hand corner of a particular widget will remove that widget from the dashboard.
pressing the cogs button immediately to the left of the X button in the top right hand corner of a particular widget will hide the chart momentarily, and instead display a list of options that are configurable for the chart.
Change which charting library to use to render the chart. Choose from:
- C3
- dimple
- NVD3
- chart.js
Alternatively, the SHARE Analytics Dashboard also provides for a way to easily develop a custom widget.
Widgets can be developed as an Ember component. A Widget manage provides an interface for the widget to communicate with the SHARE API and the SHARE Dashboard. The manager provides a container for the widget supplying the DOM element that the widget is held in, handles the accessing of the API, the customisation of queries.
A widget provides a validator which asserts that given query parameters will provide data that can be validly displayed by the widget, logic to rerender the widget when the size of the container changes, and logic to render the result of the query as a chart. Optionally, logic to render the chart as an image may also be provided.
Using this.sendAction() a widget may communicate
refreshWall
The SHARE Analytics Dashboard consists of three primary components. The app, which is an ember app that serves the front end for your bowser, the widget repo, which stores and shares widgets' types, configurations, and settings, and the dashboard repo, which stores, manages and shares dashboards' types configurations and settings.
You will need the following things properly installed on your computer.
-
git clone <repository-url>this repository -
change into the new directory
-
npm install -
bower install -
set up your config/local.yml (If this file does not exist, you may need to
ember g) -
createa new virtualenv
-
pip install -r requirements.txt -
Set up postgres
-
create a backend/settings/local.py and configure django to connect to your database in it.
-
./manage.py migrate
ember serve./manage.py runserver- Visit your app at http://localhost:4200.
Make use of the many generators for code, try ember help generate for more details
ember testember test --server
ember build(development)ember build --environment production(production)
Dockerfiles are in the repo that should provide a simple and easy way to deploy these ember and django apps.