Data

Tools

Indexes

Applications

Experiments

Open Source Science

@inb/oeb_visualizations

Library of data visualizations for OpenEBench

https://github.com/inab/oeb-visualizations

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.8%) to scientific vocabulary

Keywords

openebench plotlyjs vue
Last synced: 6 months ago · JSON representation ·

Repository

Library of data visualizations for OpenEBench

Basic Info
Statistics
  • Stars: 0
  • Watchers: 4
  • Forks: 0
  • Open Issues: 22
  • Releases: 0
Topics
openebench plotlyjs vue
Created over 2 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog Contributing License Citation

README.md

OpenEBench Visualizations

Collection of Vue components for data visualization in OpenEBench.

  • :magic_wand: Go to the live demo to see the components in action.
  • :open_book: Check the documentation for details on how to use the components.
  • :package: This package is available through npmjs.

Installation

To install the package run:

bash npm install @inb/oeb_visualizations

How to contribute

If you want to contribute to this project, please read the contributing guidelines first.

Development

This project is built using Vue.js. The components are written in Vue and the bundling is done using Rollup. The rollup configuration is in the rollup.config.js file and the main entry point is the src/index.js file, all the components are exported from this file. The components are written in the src/components folder. Each component should be in a separate folder and should contain the .vue file and, optionally, a .scss file. In order to be used in other applications, the package should be built, which creates a dist folder with the compiled files.

The documentation is built using Material for MkDocs. The content of the documentation is written in markdown and should be added to the docs folder. The configuration of the documentation is in the mkdocs.yml file. This file contains the structure of the documentation, including navigation, the theme used, etc. More information about how to configure the documentation can be found in the documentation.

How to add a new visualization.

If you want to add a new visualization, you should create a new component for it. Follow the steps below:

  • Create the new component in the src/components folder. A component can be written in only one file or, if it is complex, it can be divided into smaller components in a folder.

  • Add the new component to the index.js, as following:

    ```js import newComponent from './components/newComponent.vue'

    export { newComponent, ... } ```

If the new component is a complex component, it should be divided into smaller components. In this case, the index.js file should export the smaller components and the main component.

The documentation should be updated to include the new component.

How to document a new component.

To document a new component, add the new component to the documentation as a single file in the docs/components folder. Documentation is written in markdown and should contain at least the following sections:

  • Description of how the data being represented.
  • How to use it.
  • Example of usage.
  • Props and events.

How to build the package locally.

To build the package locally, run: bash npm run build This will create a dist folder with the compiled files. The component will be available for other applications running locally to use. To use the component in another application, you should link the package locally. To do so, run: bash npm link Then, in the application where you want to use the component, run: bash npm link @inb/oeb_visualizations This will link the local package to the application.

How to serve the documentation locally.

The documentation is built using mkdocs. To serve the documentation locally, run: bash mkdocs serve This will start a local server and the documentation will be available at http://localhost:8000/.

Publishing

Publishing a new version of the package to npm

To publish a new version of the package to npm, follow the steps below:

  • Update the version in the package.json file. If all commit messages follow the conventional commits standard, you can use the cz bump --version-scheme semver command to update the version and the CHANGELOG.md file.
  • Run the npm run build command to build the package.
  • Run the npm publish command to publish the package to npmjs.

This package is published under the @inb scope as @inb/oeb_visualizations. The package is available at https://www.npmjs.com/package/@inb/oeb_visualizations.

Publishing the documentation

The documentation is built and deployed to the gh-pages branch using GitHub Actions. Each time a new commit is pushed to the main branch, the documentation is built and deployed to the gh-pages branch.
The documentation is available at https://inab.github.io/oeb-visualizations/.

Owner

  • Name: Spanish National Bioinformatics Institute
  • Login: inab
  • Kind: organization
  • Email: salvador.capella@bsc.es
  • Location: Spain

Alfonso Valencia | BSC, ICREA, INB Director - Salvador Capella-Gutierrez | BSC, INB CTO

Citation (CITATION.cff) 

cff-version: 1.2.0
message: If you use this software, please cite it as below.
title: oeb-visualizations
authors:
- given-names: Eva Martin del Pico
  email: eva.martin@bsc.es
- given-names: OEB FAIRsoftEvaluator
  email: openebench@bsc.es
- given-names: Eva Martin del Pico
  email: eva.mdpico@gmail.com
repository: https://github.com/inab/oeb-visualizations
url: https://inab.github.io/oeb-visualizations/

GitHub Events

Total
  • Delete event: 26
  • Push event: 32
  • Pull request event: 44
  • Create event: 35
Last Year
  • Delete event: 26
  • Push event: 32
  • Pull request event: 44
  • Create event: 35

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 64
  • Total Committers: 3
  • Avg Commits per committer: 21.333
  • Development Distribution Score (DDS): 0.188
Past Year
  • Commits: 64
  • Committers: 3
  • Avg Commits per committer: 21.333
  • Development Distribution Score (DDS): 0.188
Top Committers
Name Email Commits
emarti2 e****n@b****s 52
Eva Martin del Pico e****o@g****m 11
OEB FAIRsoftEvaluator o****h@b****s 1
Committer Domains (Top 20 + Academic)
bsc.es: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 3
  • Total pull requests: 35
  • Average time to close issues: about 3 hours
  • Average time to close pull requests: 7 days
  • Total issue authors: 1
  • Total pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 32
Past Year
  • Issues: 0
  • Pull requests: 30
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 days
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 30
View more stats
Top Authors
Issue Authors
  • EvaMart (3)
  • metadata-updater-for-fairsoft[bot] (1)
Pull Request Authors
  • metadata-updater-for-fairsoft[bot] (60)
  • EvaMart (3)
  • oeb-fairsoft-evaluator[bot] (2)
Top Labels
Issue Labels
documentation (2) bug (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • npm 9 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 10
  • Total maintainers: 7
npmjs.org: @inb/oeb_visualizations

Collection of Vue components for data visualization in OpenEBench.

  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 9 Last month
Rankings
Forks count: 15.5%
Stargazers count: 21.0%
Average: 31.3%
Dependent repos count: 36.4%
Dependent packages count: 52.3%
Maintainers (7)
im_jessica jmfernandez dominik.br.bsc carleshf evamart anivalle androidbeing
Last synced: 6 months ago

Dependencies

package-lock.json npm
  • 111 dependencies
package.json npm
  • minimist ^1.2.0 development
  • rollup ^1.14.4 development
  • rollup-plugin-buble ^0.19.6 development
  • rollup-plugin-commonjs ^9.3.4 development
  • rollup-plugin-replace ^2.2.0 development
  • rollup-plugin-uglify-es 0.0.1 development
  • rollup-plugin-vue ^4.7.2 development
  • vue-template-compiler ^2.6.10 development
  • moment ^2.29.4
  • plotly.js-dist ^2.27.1
  • vue ^2.6.10
.github/workflows/main.yml actions
  • actions/cache v3 composite
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
requirements.txt pypi
  • babel *
  • colorama *
  • jinja2 *
  • markdown *
  • mkdocs *
  • mkdocs-material-extensions *
  • paginate *
  • pygments *
  • pymdown-extensions *
  • regex >=2022.4
  • requests *