FRSM checklist - Analizo

This FRSM checklist contains a set of questions extracted from the FAIR Research Software Metric to assess the research software Analizo regarding the FAIR metrics for research software.

Answers for Analizo are written in blue.

FRSM-01: Persistent Identifier

Does the software have a globally unique and persistent identifier?

• FRSM-01.1: Software has a human and machine-readable unique identifier that is resolvable to a machine-readable landing page and follows a defined unique identifier syntax.
  Analizo has SWHID autogenerated by Software Heritage platform for each version released, such as the SWHID swh:1:dir:9a683933e03f9ff968818d449a046f9a3cdd2508 for the Analizo version 1.25.4. Besides the SWHID, Analizo was also published on Zenodo.org and it has the DOI 10.5281/zenodo.3673933.
• FRSM-01.2: Identifier uses an identifier scheme that guarantees globally uniqueness and persistence.
  Analizo has DOI and SWHDI, both are schemas that guarantees uniqueness and persistence, more about SWHID specification can be found at https://www.swhid.org/specification/v1.1/0.Introduction/.
• FRSM-01.3: Identifier scheme is commonly used in the domain.
  Analizo uses the SWHID, and schema that is not commonly used in the domain yet. But its usage must increase in the following years.

FRSM-02: Components Identifiers

Do the different components of the software have their own identifiers?

• FRSM-02.1: Where the "software" consists of multiple distinct components, each component has a distinct identifier.
  No. Analizo has no multiple components.
• FRSM-02.2: The relationship between components is embodied in the identifier metadata.
  Not apply.
• FRSM-02.3: Every component to granularity level GL3 (module) has its own unique identifier.
  Not apply.

FRSM-03: Versions Identifiers

Does each version of the software have a unique identifier?

• FRSM-03.1: Each version of the software has a different identifier.
  Yes, the Software Heritage archive is automatically fetching the Analizo source-code from the Github repository https://github.com/analizo/analizo and for each release tagged on Github the Software Heritage generates a different SWHID identifying each released version.
• FRSM-03.2: Relations between the versions are included in the identifier metadata.
  No. There is no relations between versions identified in the metadata.
• FRSM-03.3: The version number is included in the identifier metadata.

FRSM-04: Purpose Metadata

Does the software include descriptive metadata which helps define its purpose?

• FRSM-04.1: The software includes a README or other file which includes the software title and description.
  Yes, the analizo source-code includes a README.md file with the software title and description.
• FRSM-04.2: The software includes other descriptive metadata such as domain, funder, programming language, date created, and keywords.
  Yes, the Analizo's README.md document includes in the description the domain of the tool, the funders supporting the project, but the programming language, date created, and keywords are missing in the README.md.
  The Analizo software paper published in 2010 documents the programming language and some other technical details, available at: https://www.analizo.org/publications/analizo-cbsoft2010-tools.pdf.
• FRSM-04.3: The metadata is contained in a format such as CodeMeta or ProjectObjectModel that enables full machine actionability.
  No, the Analizo's repository doesn’t include a codemeta.json, citation.cff of any other machine-readable file with the software metadata.

FRSM-05: Status Metadata

Does the software include development metadata which helps define its status?

• FRSM-05.1: The software includes metadata for contact or support in the README or other intrinsic metadata file according to community standards.
• FRSM-05.2: The software includes metadata for development status, links to documentation.
• FRSM-05.3: The metadata is contained in a format such as CodeMeta or ProjectObjectModel that enables full machine-actionability.

FRSM-06: Contributors Roles

Does the software include metadata about the contributors and their roles?

• FRSM-06.1: The software includes metadata about the contributors.
  Analizo: Yes and no. The analizo source code doesn’t include an AUTHOR file but the released versions include an AUTHORS file, this file is auto-generated from the git history during the release process, for eg: the last package of the Analizo version 1.25.4 includes the AUTHORS file including a full list with all the Analizo’s authors and collaboratos: https://metacpan.org/dist/Analizo/source/AUTHORS.
  F-UJI could be able to fetch the software package usually published on the repositories for the programming language in which the software is written, in the Analizo case, the programming language is Perl, and the package is published on the CPAN repository: https://metacpan.org/dist/Analizo.
• FRSM-06.2: The software includes citation metadata that includes all contributors and their roles. This includes ORCIDs when contributors have them.
  Analizo: No, analizo source doesn’t include a CITATION.cff file. But it is documented on the Analizo website https://www.analizo.org how to cite it by using as proxy to the software a software paper that was published in 2010 on the CBSOFT conference (1st Brazilian Conference on Software: Theory and Practice (CBSoft) - Tools Session).
• FRSM-06.3: Does the citation metadata include the proportional credit attributed to each contributor?
  Analizo: No, there is no CITATION.cff in the analizo repository.

FRSM-07: Identifier Metadata

Does the software metadata include the identifier for the software?

• FRSM-07.1: Does the software include an identifier in the README or citation file?
• FRSM-07.2: Does the identifier resolve to the same instance of the software?
• FRSM-07.3: N/A

FRSM-08: Metadata Record

Does the software have a publicly available, openly accessible and persistent metadata record?

• FRSM-08.1: A metadata record for the software is present on an infrastructure that guarantees persistence.
  Yes, Analizo was added to Research Software Directory (RSD), link to Analizo on RSD here.
• FRSM-08.2: The persistent metadata record is available through public search engines. The metadata has a globally unique and persistent identifier.
  Yes, the Analizo record on RSD can be found by public search engines, Google Search engine for instance.
• FRSM-08.3: The persistent metadata record is available through multiple, cross-referenced infrastructures.
  I'm not sure if RSD supports it.

FRSM-09: Code Repository

Is the software developed in a code repository / forge that uses standard communications protocols?

• FRSM-09.1: The code repository / forge can be accessed using the identifier via a standardised protocol.
  Yes, Analizo is developed using Git and the source code is hosted at Github here.
• FRSM-09.2: If authentication or authorisation are required, these are supported by the communication protocols and the repository / forge.
  No authentication is required.
• FRSM-09.3: N/A

FRSM-10: Data Formats

Are the formats used by the data consumed or produced by the software open and a reference provided to the format?

• FRSM-10.1: The documentation describes the data formats used.
• FRSM-10.2: The data formats used are open.
• FRSM-10.3: A reference to the schema is provided.

FRSM-11: Open APIs

Does the software use open APIs that support machine-readable interface definition?

• FRSM-11.1: The software provides documented APIs.
• FRSM-11.2: The APIs are open (freely accessible).
• FRSM-11.3: The APIs include a machine-readable interface definition.

FRSM-12: References Objects

Does the software provide references to other objects that support its use?

• FRSM-12.1: N/A
• FRSM-12.2: The software metadata includes machine-readable references to articles describing the software, articles demonstrating use of the software, or to the data it uses.
• FRSM-12.3: N/A

FRSM-13: Usage Requirements

Does the software describe what is required to use it?

• FRSM-13.1: The software has build, installation and/or execution instructions.
  Analizo: Yes, the installation steps is documented on the INSTALL.md file. Development instructions and how to create a environment for development is also documented on the HACKING.md file.
• FRSM-13.2: Dependencies are provided in a machine-readable format and the building and installation of the software is automated.
  Analizo: Yes, analizo is written in Perl and users Dist::Zilla framework to build the software from source code, the file dist.ini included in the repository includes and documents in a machine-readable way all the requirements and dependencies. This file also includes metadata, such as: software name, license, copyright, build requirements, test requirements.
• FRSM-13.3: N/A

FRSM-14: Test Cases

Does the software come with test cases to demonstrate it is working?

• FRSM-14.1: Tests and data are provided to check that the software is operating as expected.
  Yes.
• FRSM-14.2: Automated unit and system tests are provided.
  Yes, Analizo implements a good set of automated tests, including unit and features BDD tests, the source code of Analizo tests are available at https://github.com/analizo/analizo/tree/main/t.
• FRSM-14.3: Code coverage / test coverage is reported.
  Analizo tests reports are available. The CPAN Testers network provides automated test reports for packages distributed on the CPAN archive, Analizo test reports can be viewed at http://cpantesters.org/dist/Analizo. Besides the CPAN Testers network, reports are also provided by the Debian Continuous Integration service at https://ci.debian.net/packages/a/analizo

FRSM-15: License in Source Code

Does the software source code include licensing information for the software and any bundled external software?

• FRSM-15.1: The software includes its LICENCE file.
  Analizo: Yes and no. Analizo repository itself does not inclide a LICENSE file, but the license metadata is described in the analizo package metadata file format based on the Dist::Zilla building tool who is in charge of building the Analizo package for releases and uploads to the repositories from where the users download and install the Analizo. The Dist::Zilla file in the analizo source code is the “dist.ini” file, this file describe the license, author, compilation dependencies, and bugtracker address.
• FRSM-15.2: The source code includes licensing information for all components bundled with that software.
  Analizo: The project started based on the free software open source principles, since the beginning the project relies only on other free software and open source library and tools, there is no metadata about license of the dependencies on the analizo repository but also there is no bundled components in the analizo source code, the analizo repository contains only the analizo codebase written by analizo developers.
• FRSM-15.3: The software licensing information is in SPDX format.
  Analizo: It is ok, the SPDX is being used, analizo is licensed under the GPL_3.

FRSM-16: License in Metadata

Does the software metadata record include licensing information?

• FRSM-16.1: The identifier or metadata record includes licensing and copyright information.
• FRSM-16.2: N/A
• FRSM-16.3: The software licensing information is in SPDX format, or other machine-readable form.

FRSM-17: Provenance

Does the software include provenance information that describe the development of the software?

• FRSM-17.1: The software source code repository / forge includes a commit history.
• FRSM-17.2: The software source code repository links commits to issues / tickets.
• FRSM-17.3: The software project uses other tools to capture detailed machine readable provenance information.

Author

Joenio Marques da Costa <joenio@joenio.me>