Skip to content

athenarc/bip-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 

Repository files navigation

BIP! Badges - Interactive Bibliometric Visualization

A lightweight JavaScript library for embedding interactive charts that visualize bibliometric indicators of scientific papers. These charts are powered by the BIP! Services platform and provide an elegant way to display research impact metrics directly in web pages.

📦 Installation

Quick Start

  1. Include the embed.js or preferably the minified version embed.min.js in your HTML page:
    <script src="https://cdn.jsdelivr.net/gh/athenarc/bip-plugin@main/embed.min.js"></script>
  2. Add elements with the bip-embed class:
    <div class="bip-embed" data-doi="10.1093/nar/gkx1141"></div>
    <div class="bip-embed" data-doi="10.1038/nature12373"></div>

Multiple Charts

You can embed multiple charts on the same page - each will automatically fetch and display data for its respective DOI.

🎯 Usage Examples

Basic Implementation

<!DOCTYPE html>
<html>
<head>
    <title>Research Impact Visualization</title>
    <script src="https://cdn.jsdelivr.net/gh/athenarc/bip-plugin@main/embed.min.js"></script>
</head>
<body>
    <h1>Paper Impact Metrics</h1>
    
    <!-- Single chart -->
    <div class="bip-embed" data-doi="10.1093/nar/gkx1141"></div>
    
    <!-- Multiple charts -->
    <div class="bip-embed" data-doi="10.1038/nature12373"></div>
    <div class="bip-embed" data-doi="10.1126/science.1234567"></div>
    
</body>
</html>

📊 Performance Classifications

The BIP! Services platform offers a range of citation-based impact indicators; a detailed description of the indicators is available here.

For each indicator, the platform classifies research works into five performance tiers:

Class Label Color Description Percentage
C1 Top 0.01% #00441b Exceptional impact Top 0.01% of research works
C2 Top 0.1% #1b7837 Very high impact Top 0.1% of research works
C3 Top 1% #4daf4a High impact Top 1% of research works
C4 Top 10% #a6d96a Above average Top 10% of research works
C5 Average #808080 Average impact Remaining 90%

Visual Representation

  • C1-C4: Filled segments with green gradient (darker = higher impact)
  • C5: Unfilled arc with grey text (represents average performance)

🔍 Troubleshooting

Common Issues

Chart not displaying:

  • Check that the DOI is valid and accessible
  • Verify internet connection (API calls required)
  • Check browser console for JavaScript errors

Styling issues:

  • Ensure no CSS conflicts with existing styles
  • Check that Font Awesome and Google Fonts are loading

API errors:

  • Verify the DOI exists in the BIP database
  • Check API endpoint availability
  • Some DOIs may not have complete data

Debug Mode

Enable console logging by opening browser developer tools to see detailed information about data fetching and chart rendering.

📄 License

This project is open source. Please check the BIP! platform terms of use for further guidelines.

🤝 Contributing

Contributions are welcome! Please feel free to submit issues, feature requests, or pull requests.

📞 Support

For technical support or questions about the BIP platform:

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors