Skip to content

Commit

Permalink
Add a section on the status of CFF as compared to transitive credit a…
Browse files Browse the repository at this point in the history
…nd free-form files

- [skip ci]
  • Loading branch information
sdruskat committed Oct 25, 2017
1 parent ed121ca commit 5d0cf41
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 5 deletions.
47 changes: 42 additions & 5 deletions 1.0-RC1/specifications.md
@@ -1,5 +1,5 @@
---
title: Citation File Format (CFF)
title: Citation File Format Core (CFF-Core)
author: Stephan Druskat (mail@sdruskat.net)
abstract:
The *Citation File Format* (*CFF*) is a human- *and* machine-readable format
Expand Down Expand Up @@ -27,7 +27,7 @@ version: 1.0-RC1

## Status of this document

This document reflects the version {{ page.version }} of the *Citation File Format* (CFF).
This document reflects version {{ page.version }} of the *Citation File Format* (CFF).
CFF has been developed in the context of the [*Workshop on Sustainable Software
for Science: Practice and Experiences
(WSSSPE5.1)*](http://wssspe.researchcomputing.org.uk/wssspe5-1/), which was held
Expand All @@ -45,16 +45,17 @@ the following.

- Radovan Bast ([@bast](https://github.com/bast)): Reporter
- Raniere Silva ([@rgaiacs](https://github.com/rgaiacs)): Reporter
- Michael R. Crusoe ([@mr-c](https://github.com/mr-c)): Reporter

CFF has been developed to provide the first iteration of a format for `CITATION`
CFF has been developed to provide a format for `CITATION`
files which could be recommended to readers of the blog post which has been
produced by the group during the workshop and shortly after, and which will be
published on the [blog page](https://www.software.ac.uk/blog) of the [Software
Sustainability Institute](https://www.software.ac.uk/).

## Rationale
## Rationale[^rationale]

The rationale for a standardized, machine- and human-readable format for
[^rationale]: The rationale for a standardized, machine- and human-readable format for
`CITATION` files is discussed in more detail in
{% cite standardized-citation-files --style ./_bibliography/apa-text.csl %}. CFF has been developed to support all
use cases for the citation of software, as
Expand All @@ -79,6 +80,42 @@ readability is a precondition for re-use of the citation information in
different contexts which could further support a fair distribution of credit for
research software.

## Status of the format

CFF-Core has been branched out to address
[issue citation-file-format/citation-file-format#23](https://github.com/citation-file-format/citation-file-format/issues/23).
While an ideal format for software citation would arguably implement transitive
credit {% cite transitive-credit %}, there is no concrete implementation yet
that is available for practical use by software creators. The most concrete
suggestion for an implementation is {% cite transitive-credit-json-ld --style ./_bibliography/apa-text.csl %}, the
application of which, however, seems impractical from a usability point of view
in terms of human-writability. Especially regarding the current state of the
practice of providing citation metadata for software (cf.
{% cite software-citation-practices --style ./_bibliography/apa-text.csl %}) it seems that at this point in time, a lower-threshold
approach - in terms of technical complexity - could potentially drive higher participation
in the provision of software citation metadata.

On the other end of the complexity spectrum, free form `CITATION` files as suggested by Robin
Wilson {% cite citation-files %} provide an easy-to-access way of providing citation metadata
for software. However, as these files are not reliably formatted, and thus not
machine-readable, their potential for re-use is rather low. Re-use of software citation metadata, however,
is a key factor in the promotion of software citation along the software citation principles
{% cite principles %}, and ultimately the fair distribution of credit for software in science.

CFF aims to provide a compromise between the ideal state of software
citation, i.e., transitive credit, and the state of the practice, i.e., free form
`CITATION` files.

CFF-Core, in this context, provides an implementation for basic
software citation metadata, so that creators of research software can supply relevant
metadata for citation easily. CFF-Core aims at covering use cases *1 (Use software for a paper)*,
*2 (Use software in/with new software)*, and *15 (Store software entry)* as
defined in the software citation principles paper {% cite principles %}.

Further development of CFF towards an implementation of transitive credit may be
undertaken in the future in another branch of CFF which may serve as an extension
to CFF-Core.

## Goals
The goal of CFF is to provide an all-purpose citation format (similar to BibTeX
or RIS), and specifically provide optimized means of citation for software via
Expand Down
15 changes: 15 additions & 0 deletions _bibliography/references.bib
Expand Up @@ -75,4 +75,19 @@ @Article{transitive-credit-json-ld
number = {e7},
doi = {10.5334/jors.by},
url = {https://doi.org/10.5334/jors.by},
}

@Article{software-citation-practices,
author = {Howison, James and Bullard, Julia},
title = {Software in the scientific literature: Problems with seeing, finding, and using software mentioned in the biology literature},
journal = {Journal of the Association for Information Science and Technology},
year = {2016},
volume = {67},
number = {9},
pages = {2137--2155},
issn = {2330-1643},
abstract = {Software is increasingly crucial to scholarship, yet the visibility and usefulness of software in the scientific record are in question. Just as with data, the visibility of software in publications is related to incentives to share software in reusable ways, and so promote efficient science. In this article, we examine software in publications through content analysis of a random sample of 90 biology articles. We develop a coding scheme to identify software “mentions” and classify them according to their characteristics and ability to realize the functions of citations. Overall, we find diverse and problematic practices: Only between 31% and 43% of mentions involve formal citations; informal mentions are very common, even in high impact factor journals and across different kinds of software. Software is frequently inaccessible (15%–29% of packages in any form; between 90% and 98% of specific versions; only between 24%–40% provide source code). Cites to publications are particularly poor at providing version information, whereas informal mentions are particularly poor at providing crediting information. We provide recommendations to improve the practice of software citation, highlighting recent nascent efforts. Software plays an increasingly great role in scientific practice; it deserves a clear and useful place in scholarly communication.},
doi = {10.1002/asi.23538},
keywords = {biology, journals, bibliographic citations},
url = {http://dx.doi.org/10.1002/asi.23538},
}

0 comments on commit 5d0cf41

Please sign in to comment.