cff-in-the-wild
Analysis of Citation File Format files on GitHub
Science Score: 54.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
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
2 of 6 committers (33.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.7%) to scientific vocabulary
Repository
Analysis of Citation File Format files on GitHub
Basic Info
- Host: GitHub
- Owner: sdruskat
- License: apache-2.0
- Language: Jupyter Notebook
- Default Branch: develop
- Size: 506 KB
Statistics
- Stars: 2
- Watchers: 5
- Forks: 0
- Open Issues: 21
- Releases: 0
Metadata Files
README.md
cff-in-the-wild
Analysis of Citation File Format files on GitHub.
This is an SSI Collaborations Workshop 2022 hack day project 😍.
Repository structure 🗂️
. (root)/ You are here.
├─ code/
│ ├─ data-retrieval/ Code/software for data retrieval from GitHub
├─ data/ The data we analyse
│ ├─ raw/ NEVER MAKE THIS PUBLIC! DATA PRIVACY!
├─ output/
│ ├─ figures/ Figures for the presentation
Introduction
The Citation File Format enables you to provide the citation metadata for your software in easy-to-read YAML files. There are now several thousand CITATION.cff files on GitHub alone.
This project looks at how these files are actually used:
- Are they used correctly (i.e., do they conform to the format specifications)?
- Which versions of the format are used?
- What context are they used in, with what programming languages, licenses, etc.?
Usage
A dataset with some thousand links to repositories containing CITATION.cff files are in data/cff_repositories.csv.
Some of the analyses are run in R, some in Python.
Contributing ✏️
This is a collaborative project and we welcome suggestions and contributions. We hope one of the invitations below works for you, but if not, please let us know!
🏃 I'm busy, I only have 1 minute
- Tell a friend about the project!
⏳ I've got 5 minutes - tell me what I should do
- Suggest research ideas: what do you want to know about how Citation File Format files are used?
💻 I've got a few hours to work on this
- Take a look at the issues and see if there are any you can contribute to
🎉 I really want to help increase the community
- Organise a hackday to use or improve the code, documentation, or data in this project
Please open a GitHub issue to suggest a new idea or let us know about bugs.
Licenses ⚖️
Software code and notebooks from this project are licensed under the open source Apache License, v2.0 license. Project documentation and images are licensed under CC BY 4.0. Data produced by this project in the data/outputs directory is licensed under CC0. Other data included in this project from other sources remains licensed under its original license.
Contributors 💖
See the CITATION.cff file :tada:.
Owner
- Name: Stephan Druskat
- Login: sdruskat
- Kind: user
- Location: Berlin
- Company: German Aerospace Center (DLR)
- Website: http://sdruskat.net
- Twitter: stdruskat
- Repositories: 12
- Profile: https://github.com/sdruskat
Software Engineering PhD candidate @DLR-SC, Research Software Engineer (https://hexatomic.github.io)
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: CFF in the Wild
message: Please cite this software using these metadata.
type: software
authors:
- given-names: Amal
family-names: Alghamdi
orcid: https://orcid.org/0000-0003-0145-5296
- given-names: Hugo
family-names: Gruson
orcid: 'https://orcid.org/0000-0002-4094-1476'
- given-names: Jez
family-names: Cope
orcid: https://orcid.org/0000-0003-3629-1383
- given-names: Mark
family-names: Basham
orcid: 'https://orcid.org/0000-0002-8438-1415'
- given-names: Sam
family-names: Harrison
orcid: 'https://orcid.org/0000-0001-8491-4720'
- given-names: Stephan
family-names: Druskat
orcid: 'https://orcid.org/0000-0003-4925-7248'
repository-code: 'https://github.com/sdruskat/cff-in-the-wild'
license: Apache-2.0
version: 0.1.0
date-released: '2022-04-07'
GitHub Events
Total
Last Year
Committers
Last synced: 10 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Stephan Druskat | s****t@d****e | 23 |
| Sam Harrison | s****g@g****m | 8 |
| Hugo Gruson | B****o | 5 |
| amalghamdi | a****i@g****m | 2 |
| Jez Cope | j****e@e****k | 2 |
| Mark Basham | m****m@r****k | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 42
- Total pull requests: 48
- Average time to close issues: about 3 hours
- Average time to close pull requests: 11 minutes
- Total issue authors: 1
- Total pull request authors: 6
- Average comments per issue: 0.81
- Average comments per pull request: 0.21
- Merged pull requests: 39
- Bot issues: 0
- Bot pull requests: 0
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
- sdruskat (23)
Pull Request Authors
- sdruskat (9)
- Bisaloo (6)
- samharrison7 (5)
- amal-ghamdi (3)
- jezcope (2)
- markbasham (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- gh * imports
- purrr * imports
- atomicwrites 1.4.0 develop
- attrs 21.4.0 develop
- colorama 0.4.4 develop
- more-itertools 8.12.0 develop
- packaging 21.3 develop
- pluggy 0.13.1 develop
- py 1.11.0 develop
- pyparsing 3.0.7 develop
- pytest 5.4.3 develop
- wcwidth 0.2.5 develop
- pyyaml 6.0
- pytest ^5.2 develop
- PyYAML ^6.0
- python ^3.8
- requests *