researchsoftwaremetadata.jl

Research Software Metadata crosswalk code

https://github.com/boydorr/researchsoftwaremetadata.jl

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 1 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
✓
Committers with academic emails
1 of 2 committers (50.0%) from academic institutions
✓
Institutional organization owner
Organization boydorr has institutional domain (www.gla.ac.uk)
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.3%) to scientific vocabulary

Keywords from Contributors

mesh interactive

Last synced: 10 months ago · JSON representation

Repository

Research Software Metadata crosswalk code

Basic Info

Host: GitHub
Owner: boydorr
License: bsd-2-clause
Language: Julia
Default Branch: main
Size: 668 KB

Statistics

Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Releases: 6

Created almost 2 years ago · Last pushed about 1 year ago

Metadata Files

Readme Changelog License Codemeta Zenodo

ResearchSoftwareMetadata

Summary

ResearchSoftwareMetadata is a Julia package that provides functionality for to allow a crosswalk between Project.toml, codemeta.json, .zenodo.json and the package LICENSE file to allow a consistent way of providing metadata for research software which allows the Julia General Registry to pick up the same metadata as GitHub and Zenodo while following the Research Software MetaData guidelines.

Installation

The package is registered in the General registry so can be built and installed with add. For example:

``julia (@v1.10) pkg> add ResearchSoftwareMetadata Resolving package versions... Updating~/.julia/environments/v1.10/Project.toml[aea672f4] + ResearchSoftwareMetadata v0.1.2 Updating~/.julia/environments/v1.10/Manifest.toml`

(@v1.10) pkg> ```

Usage

First you need to add a small amount of additional metadata into your Project.toml file.

To capture the license you are using and propagate it throughout the metadata files and through your julia code, add an SPDX license identifier to the file:

toml license = "BSD-2-Clause"

To supplement the metadata on the authors of the package, add the ORCID for each author and the ROR for the organisation(s) they are affiliated with. You can add as many authors and as much or as little information as you like about each one by adding additional [[author_details]] blocks.

```toml [[author_details]] name = "Richard Reeve" orcid = "0000-0003-2589-8091"

[[author_details.affiliation]]
ror = "00vtgdb53"

```

Then, from the root of your package, you can just run a crosswalk:

```julia using Pkg

Create a new project with ResearchSoftwareMetadata in it

Pkg.activate(; temp = true) Pkg.add("ResearchSoftwareMetadata")

Carry out a crosswalk between the different metadata formats

using ResearchSoftwareMetadata ResearchSoftwareMetadata.crosswalk() ```

If you want to add in some additional metadata (the category of the software, or the keywords associated with it, or you want to increase the package version during the crosswalk, this is possible as follows:

```julia

Add in additional metadata

ResearchSoftwareMetadata.crosswalk(category = "metadata", keywords = ["julia", "metadata", "research software", "RSMD"])

Increase version number during crosswalk

ResearchSoftwareMetadata.increasepatch() # Bump patch version (e.g. 0.4.1 -> 0.4.2) ResearchSoftwareMetadata.increaseminor() # Bump minor version (e.g. 0.4.1 -> 0.5.0) ResearchSoftwareMetadata.increase_major() # Bump major version (e.g. 0.4.1 -> 1.0.0) ```

You might also consider reformatting all of your julia code to a consistent format. A .JuliaJormatter.toml file in the package root defines what the formatting standard should be.

julia Pkg.add("JuliaFormatter") Pkg.develop("MyPackage") using JuliaFormatter using MyPackage format(MyPackage)

Owner

Name: Boyd Orr
Login: boydorr
Kind: organization
Location: Glasgow, UK

Website: http://www.gla.ac.uk/boydorr
Repositories: 28
Profile: https://github.com/boydorr

Boyd Orr Centre for Population and Ecosystem Health, University of Glasgow

CodeMeta (codemeta.json)

{
  "@context": "https://w3id.org/codemeta/3.0",
  "type": "SoftwareSourceCode",
  "applicationCategory": "metadata",
  "programmingLanguage": "julia",
  "developmentStatus": "active",
  "codeRepository": "https://github.com/boydorr/ResearchSoftwareMetadata.jl",
  "name": "ResearchSoftwareMetadata.jl",
  "issueTracker": "https://github.com/boydorr/ResearchSoftwareMetadata.jl/issues",
  "readme": "https://github.com/boydorr/ResearchSoftwareMetadata.jl/blob/main/README.md",
  "buildInstructions": "https://github.com/boydorr/ResearchSoftwareMetadata.jl/blob/main/README.md",
  "dateCreated": "2024-07-17",
  "operatingSystem": [
    "Linux",
    "macOS"
  ],
  "version": "v0.1.5",
  "dateModified": "2025-04-02",
  "datePublished": "2024-07-18",
  "downloadUrl": "https://github.com/boydorr/ResearchSoftwareMetadata.jl/archive/refs/tags/v0.1.5.tar.gz",
  "license": "https://spdx.org/licenses/BSD-2-Clause",
  "author": [
    {
      "type": "Person",
      "givenName": "Richard",
      "familyName": "Reeve",
      "email": "richard.reeve@glasgow.ac.uk",
      "id": "https://orcid.org/0000-0003-2589-8091",
      "affiliation": [
        {
          "type": "Organization",
          "name": "University of Glasgow",
          "identifier": "https://ror.org/00vtgdb53"
        }
      ]
    }
  ],
  "continuousIntegration": "https://github.com/boydorr/ResearchSoftwareMetadata.jl/actions/workflows/testing.yaml",
  "codemeta:contIntegration": {
    "id": "https://github.com/boydorr/ResearchSoftwareMetadata.jl/actions/workflows/testing.yaml"
  },
  "keywords": [
    "RSMD",
    "julia",
    "metadata",
    "research software"
  ]
}

GitHub Events

Total

Create event: 4
Commit comment event: 3
Release event: 1
Delete event: 1
Issue comment event: 2
Push event: 7
Pull request event: 4

Last Year

Create event: 4
Commit comment event: 3
Release event: 1
Delete event: 1
Issue comment event: 2
Push event: 7
Pull request event: 4

Committers

Last synced: 11 months ago

All Time

Total Commits: 51
Total Committers: 2
Avg Commits per committer: 25.5
Development Distribution Score (DDS): 0.02

Past Year

Commits: 51
Committers: 2
Avg Commits per committer: 25.5
Development Distribution Score (DDS): 0.02

Top Committers

Name	Email	Commits
richardreeve	r**e@g**k	50
dependabot[bot]	4****]	1

Committer Domains (Top 20 + Academic)

glasgow.ac.uk: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time

Total issues: 1
Total pull requests: 2
Average time to close issues: less than a minute
Average time to close pull requests: 2 months
Total issue authors: 1
Total pull request authors: 2
Average comments per issue: 6.0
Average comments per pull request: 0.5
Merged pull requests: 2
Bot issues: 0
Bot pull requests: 1

Past Year

Issues: 1
Pull requests: 2
Average time to close issues: less than a minute
Average time to close pull requests: 2 months
Issue authors: 1
Pull request authors: 2
Average comments per issue: 6.0
Average comments per pull request: 0.5
Merged pull requests: 2
Bot issues: 0
Bot pull requests: 1

View more stats

Top Authors

Issue Authors

Pull Request Authors

dependabot[bot] (2)
richardreeve (2)

Top Labels

Issue Labels

Pull Request Labels

dependencies (2)

Packages

Total packages: 1
Total downloads: unknown

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 6

juliahub.com: ResearchSoftwareMetadata

Research Software Metadata crosswalk code

Documentation: https://docs.juliahub.com/General/ResearchSoftwareMetadata/stable/
License: BSD-2-Clause
Latest release: 0.1.5
published about 1 year ago

Versions: 6
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 3.2%

Downloads: 4.4%

Average: 8.0%

Dependent packages count: 16.3%

Last synced: 10 months ago

Dependencies

.github/workflows/CompatHelper.yaml actions

.github/workflows/TagBot.yaml actions

JuliaRegistries/TagBot v1 composite

.github/workflows/testing.yaml actions

actions/checkout v4 composite
codecov/codecov-action v4 composite
julia-actions/cache v2 composite
julia-actions/julia-buildpkg v1 composite
julia-actions/julia-docdeploy v1 composite
julia-actions/julia-processcoverage v1 composite
julia-actions/julia-runtest v1 composite
julia-actions/setup-julia v2 composite