Nitrate Processed Mincemeat

    data-metrics-badge

    0.5.5 • Public • Published

    Published on webcomponents.org npm version Build Status

    Data Metrics Badge

    The Data Metrics Badge provides an open and easy way to display the number of citations and usage that your research datasets and resources have received.

    The Data Metrics Badge was created as part of the PARSEC, Building New Tools for Data Sharing and Reuse through a Transnational Investigation of the Socioeconomic Impacts of Protected Areas.

    The Data Metrics Badge is a an easy way to embed usage and citations metrics from DataCite Services on your repository landing page. Usage statistics are processed according to the Code of Practice for Research Data. Citation statistics are collected via the DataCite and Crossref EventData Service.

    Browsers support

    IE / EdgeIE / Edge FirefoxFirefox ChromeChrome SafariSafari OperaOpera
    Edge last 2 versions last 2 versions last 2 versions last 2 versions

    One will need to include the web-components-loader for Edge and IE compatibility.

      <script src="https://unpkg.com/browse/@webcomponents/webcomponentsjs@2.0.0/webcomponents-loader.js"></script>

    Installation and Usage

    Getting set up with a Data Metrics Badge is a straightforward process – just add the following code to the HTML of your website wherever you want the Data Metrics Badge to appear:

    <script src="https://unpkg.com/vue"></script>
    <script src="https://cdn.jsdelivr.net/npm/data-metrics-badge/dist/data-metrics-badge.min.js"></script>
    
    
    <body>
      <data-metrics-badge doi="10.7272/q6g15xs4"></data-metrics-badge>
    </body>
    

    There is also a live demo.

    Project setup

    yarn install
    

    Compiles and hot-reloads for development

    yarn serve
    

    Compiles and minifies for production

    yarn build --target wc --name data-metrics-badge 'src/components/DataMetricsBadge.vue'
    
    npm version patch -m "Upgrade to %s for reasons"
    

    Run your tests

    yarn test:unit tests/
    

    Lints and fixes files

    npm run lint
    

    Publishing to NPMJS.com

    After merging changes via a pull request, manually run the bump-version github action, using the next version number after the last released version. The bump-version action will set the correct version in package.json, commit it, and create a release tag. Then, create a release using that tag.

    Contributing

    1. Fork it!
    2. Create your feature branch: git checkout -b my-new-feature
    3. Commit your changes: git commit -am 'Add some feature'
    4. Push to the branch: git push origin my-new-feature
    5. Submit a pull request :D

    License

    MIT

    Customize configuration

    See Configuration Reference.

    Keywords

    none

    Install

    npm i data-metrics-badge

    DownloadsWeekly Downloads

    452

    Version

    0.5.5

    License

    MIT

    Unpacked Size

    769 kB

    Total Files

    8

    Last publish

    Collaborators

    • richardhallett
    • datacite-dev
    • kristian.garza