Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

https://doi.org/10.5281/zenodo.10456900
26 August 2025, 17:01:08 UTC
  • Code
  • Branches (0)
  • Releases (6)
  • Visits
    • Branches
    • Releases
      • 6
      • 6
      • 5
      • 4
      • 3
      • 2
      • 1
    • 7a01f5a
    • /
    • fulcrumgenomics-fgbio-195055d
    • /
    • run_metrics_doclet.sh
    Raw File Download

    To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
    Select below a type of object currently browsed in order to display its associated SWHID and permalink.

    • content
    • directory
    • snapshot
    • release
    origin badgecontent badge
    swh:1:cnt:e663f10543b8169ab5efc97f23384b4dce3f7701
    origin badgedirectory badge
    swh:1:dir:886292b55f846ff2aa89c4cc876abd20e54968be
    origin badgesnapshot badge
    swh:1:snp:27b2302a38357a1a9c601d94448d2d89044a4c9c
    origin badgerelease badge
    swh:1:rel:8c00ab8dcb9eb7788debcf3c39178f4ba11723dd

    This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
    Select below a type of object currently browsed in order to generate citations for them.

    • content
    • directory
    • snapshot
    • release
    Generate software citation in BibTex format (requires biblatex-software package)
    Generating citation ...
    Generate software citation in BibTex format (requires biblatex-software package)
    Generating citation ...
    Generate software citation in BibTex format (requires biblatex-software package)
    Generating citation ...
    Generate software citation in BibTex format (requires biblatex-software package)
    Generating citation ...
    run_metrics_doclet.sh
    #!/bin/bash
    
    ##################################################################################
    # The MIT License                                                                #
    #                                                                                #
    # Copyright (c) 2015-2016 Fulcrum Genomics LLC                                   #
    #                                                                                #
    # Permission is hereby granted, free of charge, to any person obtaining a copy   #
    # of this software and associated documentation files (the "Software"), to deal  #
    # in the Software without restriction, including without limitation the rights   #
    # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell      #
    # copies of the Software, and to permit persons to whom the Software is          #
    # furnished to do so, subject to the following conditions:                       #
    #                                                                                #
    # The above copyright notice and this permission notice shall be included in     #
    # all copies or substantial portions of the Software.                            #
    #                                                                                #
    # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR     #
    # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,       #
    # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE    #
    # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER         #
    # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,  #
    # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN      #
    # THE SOFTWARE.                                                                  #
    ##################################################################################
    
    ###############################################################################
    # Simple shell script to generate metrics documentation with scaladoc
    ###############################################################################
    
    set -euo pipefail
    
    # Uncomment the following line to turn on debugging when running scaladoc
    # JAVA_OPTS="-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=7777"
    
    sources=$(find src/main/scala -name \*.scala)
    cp=$(sbt -Dsbt.log.noformat=true "export runtime:fullClasspath" 2> /dev/null | tail -n 1)
    
    scaladoc -toolcp $cp -d target -doc-generator com.fulcrumgenomics.internal.FgMetricsDoclet $sources
    

    back to top

    Software Heritage — Copyright (C) 2015–2025, The Software Heritage developers. License: GNU AGPLv3+.
    The source code of Software Heritage itself is available on our development forge.
    The source code files archived by Software Heritage are available under their own copyright and licenses.
    Terms of use: Archive access, API— Content policy— Contact— JavaScript license information— Web API