Science Score: 31.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
○codemeta.json file
-
○.zenodo.json file
-
✓DOI references
Found 1 DOI reference(s) in README -
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (9.0%) to scientific vocabulary
Repository
CW21 testing repository
Basic Info
- Host: GitHub
- Owner: c-martinez
- License: apache-2.0
- Language: Python
- Default Branch: main
- Size: 40 KB
Statistics
- Stars: 1
- Watchers: 6
- Forks: 0
- Open Issues: 5
- Releases: 0
Metadata Files
README.md
test-tool: A sample repository for testing HowFairIs and SOMEF
howfairis is a tool to measure level of adherence to the five recommendations on fair-software.eu website. It allows users to automatically check the compliance of their code and produce a badge displaying the score of their software.
SOMEF is a tool for extracting automatically metadata from code repositories, based on their readme file. SOMEF creates a Codemeta.json file automatically.
Requirements
Some text explaining the dependencies of the tool. Example: You will need python 3.6
Installing test-tool
This is some sample to emulate an explanation of installation instructions. For example
bash
pip3 install test
Running test-tool
This is an example of the command line explanation of the tool. In general it's always a good practice to explain how it would be run. For example:
bash
python3 test.py
Citing test tool
@inproceedings{test,
title={SomeTitle},
author={First Author},
booktitle={Conference},
pages={00--100},
year={2021},
doi = {10.1007/978-3-319-68204-4_9}
}
Contributing
Reference to the code of conduct goes here
FAQ
- Problem A? Answer A
Owner
- Name: Carlos Martinez
- Login: c-martinez
- Kind: user
- Company: @NLeSC
- Website: https://fosstodon.org/@neocarlitos
- Repositories: 108
- Profile: https://github.com/c-martinez
Citation (citation_check.py)
import sys
import argparse
from howfairis import Repo, Checker
parser = argparse.ArgumentParser(description='Citation checker using howfairis')
parser.add_argument('--url', action='store', type=str, help='Repository url.')
args = parser.parse_args()
url = args.url
repo = Repo(url)
checker = Checker(repo, is_quiet=True)
compliance = checker.check_five_recommendations()
if compliance.citation:
sys.exit(0)
else:
sys.exit(1)
GitHub Events
Total
Last Year
Committers
Last synced: over 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Faruk D | f****n | 20 |
| Carlos Martinez | c****z@e****l | 4 |
| Daniel Garijo | d****v@g****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: over 1 year ago
All Time
- Total issues: 12
- Total pull requests: 4
- Average time to close issues: about 2 hours
- Average time to close pull requests: 5 minutes
- Total issue authors: 4
- Total pull request authors: 1
- Average comments per issue: 0.83
- Average comments per pull request: 0.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 4
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- c-martinez (5)
- bielsnohr (3)
- dgarijo (3)
- pgmccann (1)
Pull Request Authors
- github-actions[bot] (4)