RSMD checklist - Analizo

This RSMD checklist contains a set of questions extracted from the Research Software MetaData (RSMD) guidelines to assess the research software Analizo regarding the necessary metadata to be accessible, discoverable and reusable.

Answers for Analizo are in blue for affimative answers, red for negative answers, or yellow when there is no answer.

RSMD-1: General Metadata Requirements

• RSMD-1.1: Does the software have metadata that is embedded in the source code (intrinsic metadata)?
  Yes. In the META.yml.
• RSMD-1.2: Does the software project have a metadata record (extrinsic metadata) which is publicly available on an online scholarly platform?
  Yes, it's published at the Research Software Directory (RSD), here.
  • Is the metadata record licensed as CC0?
    I don't know.
• RSMD-1.3: Is the software also available in a version control system (VCS)?
  Yes. At the Github.
  • If it is available online, is the url available in a code repository property in the intrinsic or/and extrinsic metadata?
    Yes. In the META.yml line 54.
• RSMD-1.4: Does the software follow language specific community standards?
  Yes. It adhere to Perl community good practices.
• RSMD-1.5: Is the machine readable metadata information in a single file?
  No. It's spreaded among the files: AUTHORS, META.yml, Analizo.pm.

RSMD-2: Accessibility and preservation

• Is the software record or/and are the software artifacts accessible and preserved?
  • RSMD-2.1: Is the software source code preserved in the SWH universal source code archive, Software Heritage?
    Yes. At the SWH.
  • RSMD-2.2: Is the software archived in a scholarly repository (e.g Zenodo, HAL)?
    Yes. At the Zenodo.
  • Can it be accessed and downloaded?
    Yes.
• RSMD-2.3: Is the software registered in a disciplinary or community registry (e.g ascl.net, bio.tools, swMath, RRID portal, RSD, WikiData, DataCite)
  Yes. At the RSD.
  • Can it be found in a search engine?
    Yes.

RSMD-3: Reference and identification

• RSMD-3.1: Are the software versions clearly identified?
  Yes. Git tags at the Github.
• RSMD-3.2: Are intrinsic identifiers available: Yes.
  • Can specific algorithms or code fragments be identified?
    Yes. With the SWH.
  • Can a file or directory be identified?
    Yes. With the SWH.
  • Can different revisions or releases be identified?
    Yes. With the SWH.
• RSMD-3.3: Are extrinsic identifiers available?
  Yes. DOI 10.5281/zenodo.3673933.
  • Can different releases be specifically identified?
    No. Just the version 1.23.0.
  • Can the project be identified?
    Yes.
  • If applicable, can a module be identified?
    No.
• RSMD-3.4: Is a versioning scheme used?
  Yes. Semantic Versioning.
• RSMD-3.5: Is it possible to identify different levels of granularity?
  Yes. With the DOI or SWHID.

RSMD-4: Description & classification

• RSMD 4.1: Is the information about the software name and description available (on README file or other intrinsic metadata file)?
  Yes. In the README.md and META.yml.
• RSMD 4.2: Does the metadata record contain descriptive metadata?
  • Name Yes.
  • Description Yes.
  • Domain Yes.
  • Programming language No.
  • Date created No.
  • Date of first publication No.
  • Keywords No.
  • Related links No.
  • Version Yes.
• RSMD 4.3: Is it possible to access articles describing the software via a persistent identifier, or at least, a stable URL?
  Yes. Stable URL.
• RSMD 4.4: Is the intrinsic metadata of the software description available in a machine readable file?
  Yes. In the file META.yml.
• RSMD 4.5: Is additional information (e.g. provenance information, functionalities, development status, etc.) on the software available in the README file?
  No.

RSMD-5: Attribution & credit

• Are the authors & contributors identified and acknowledged?
  • RSMD-5.1: Is the author's information available in the source code as intrinsic metadata?
    Yes. In the AUTHORS.
  • RSMD-5.2: Is the author's information available on the metadata record as extrinsic metadata?
    Partially.
  • RSMD-5.8: Is the list of authors exhaustive or is a collective author used?
    Yes. Exhaustive list.
• RSMD-5.3: Are people identifiers used? (ORCID, ID-HAL, ID-REF, etc.)
  No.
• RSMD-5.4: Are the roles of the authors and contributors specified?
  No.
• RSMD-5.5: Is a citation preference provided?
  No.
• RSMD-5.6: Is software explicitly cited and included in the bibliography?
  No.
• RSMD-5.7: If applicable, in the article citing the software, is the appropriate granularity used?
  No. (TODO: Add CITATION.cff).

RSMD-6: Reuse, licensing and legal aspects

• RSMD-6.1: Before choosing a license, did you verify who is the rights holder of the software?
  Yes.
• RSMD-6.2: Is the license information available in the source code (intrinsic metadata file)?
  Yes. GNU GPL version 3, here.
  • If there are several licenses, are all defined in the software source code?
    Not apply.
  • RSMD-6.6: In the source code are the following attributes available alongside the license: name of the software, year, copyright holder, contact information (email), license identifier (e.g. SPDX)
    Yes. In the Analizo.pm.
• RSMD-6.3: Is the license information available in the metadata record?
  Yes. At Zenodo.
  • Is the license information in the code the same as the property on the metadata record?
    Yes.
• RSMD-6.4: Are external software modules used identified with their authors and license? for compliance purposes, it is necessary to verify licenses compatibility
  No. It's not needed.
• RSMD-6.5: Are the versions and contributions tracked? Using a VCS is preferable
  Yes. With Git at the Github.

RSMD-7: Re-execute: Dependencies and execution environment

• RSMD-7.1: Are the software dependencies described?
  Yes.
  • Is the description of the dependencies available in a machine-actionable format?
    Yes. Here dist.ini and here META.yml.
• RSMD-7.2: Are the operating system and relevant environment requirements described?
  Partially.
• RSMD-7.3: Are the hardware and relevant hardware platform requirements described?
  No.
• RSMD-7.4: Are the build instructions available?
  Yes. In the INSTALL.md and HACKING.md.
  • If applicable, are the build configuration files for the specific ecosystem (Makefile, Ant files, Dockerfile, etc.) and appropriate test cases provided?
    Yes.
• RSMD-7.5: Is the user documentation available?
  Yes. It's available at MetaCPAN.
  • Are the input/output formats specified?
    Yes.
  • Are there examples available?
    Yes. Example such as analizo-graph tool at MetaCPAN.
• RSMD-7.6: Are the data used and/or produced by the software described or linked?
  Partially.
  • If applicable, is there a sample provenance trace/log of an execution, including pointers to input data and expected results available?
    Yes. There are user stories documented as automated BDD tests. Such as this BDD test source code example.

Author

Joenio Marques da Costa <joenio@joenio.me>