# HG changeset patch # User Chris Cannam # Date 1317031380 -3600 # Node ID f77c007f21f71436022e99dcf1a43ee2155d850a # Parent 3040c9af84c2c9547abad14af25c86c47b2dd407 incentives for publication, small rephrase to Chordino, start on recommendations diff -r 3040c9af84c2 -r f77c007f21f7 cannam.tex --- a/cannam.tex Sun Sep 25 22:42:42 2011 +0100 +++ b/cannam.tex Mon Sep 26 11:03:00 2011 +0100 @@ -353,10 +353,18 @@ \subsection{Barrier to reuse: Lack of incentive for publication} -[TODO: Code site helps here -- it makes it more likely your - publication will be cited because people who are looking first and - foremost for code implementations will have a handy reference right - in front of them] +In section \ref{sec:researchsoft} we noted that software and data are +not typically recognised as assessable research outputs. Software +also lacks the publication convention for describing authorship +hierarchy, making it unclear how an academic should be recognised for +their contribution to a collaborative software work. + +Our code site permits users to give publication references for their +code, which are shown on their project's front page. This not only +increases the likelihood of the code being discovered by users +searching for publications by title, but also ensures that anyone +seeking the code will know how to cite its methods in their own +publications, increasing the citation impact of the work. \subsection{Barrier to reuse: Platform incompatibilities} @@ -426,39 +434,47 @@ SoundSoftware code repository described in section \ref{sec:codesite}. -\subsection{Chordino and NNLS Chroma} +\subsection{Chordino audio chord recogniser} \label{sec:chordino} -% Note that in this case the author did _not_ follow a RR methodology, and the code is not referred to in the paper. The link between code and publication must be made after the fact. +Mauch describes in~\cite{mauch2010} a method for improving automatic +recognition of chords by a prior approximate note transcription step. +This is a traditional publication which appeared without accompanying +code or test data. Although no formal attempt was made initially +toward reproducibility, some independent evaluation was carried out +through the submission of a MATLAB implementation of the method to the +annual MIREX evaluation exchange~\cite{mirex}. -Mauch describes in~\cite{mauch2010} a method for improving automatic -recognition of chords whose fundamental frequencies are easily -confused with other partials. This is a traditional publication which -appeared without accompanying code or test data. Although no formal -attempt was made initially toward reproducibility, some independent -evaluation was carried out through the submission of a MATLAB -implementation of the method to the annual MIREX evaluation -exchange~\cite{mirex}. - -Following this publication, we worked with the author of the paper and -code to develop a C++ implementation of the method and turn it into a -Vamp plugin for chord estimation, named Chordino. This code and its +Following this publication, the author of the paper and code worked +with us to develop a C++ implementation of the method and turn it into +a Vamp plugin for chord estimation, named Chordino. This code and its revision history are available through our code site\footnote{\tt http://code.soundsoftware.ac.uk/projects/nnls-chroma} and thereby linked with the associated publication. Although the code has been updated since release, the plugin includes a mode in which it uses the same method as that submitted to the MIREX evaluation. As a -consequence, although this paper still lacks a true reproducibility -compendium, a high degree of openness and effective reusability have -been achieved even though the process did not begin until after the -initial publication. - -%\subsection{Auditory Image Models} -%\label{subsubsec:aim} +consequence, even though this process did not begin until after the +initial publication, a high degree of openness and effective +reusability have been achieved. \section{Recommendations} \label{sec:recommendations} +Research groups wishing to improve software development practice for +their researchers have a number of options which may prove relatively +straightforward to carry out. + +In section~\ref{sec:lackofeducation} we observe that even skills which +may be considered very basic in the context of software engineering, +such as an introduction to program structure across multiple source +files and functions, may yield tangible rewards. To this end, we +encourage researchers to make use of the video material from our +Autumn School\footnote{\tt + http://soundsoftware.ac.uk/autumnschool2010video} and the related +Software Carpentry course material.\footnote{\tt + http://software-carpentry.org/} + + [1. Software development training -- pick small battles -- testing, provenance etc]