From f6c049905af2f7894dac622b458d19b9bbd8af89 Mon Sep 17 00:00:00 2001 From: Boud Roukema Date: Sun, 3 Jan 2021 11:23:19 +0100 Subject: Minor copyediting This commit does some minor copyediting, especially of the introduction to the supplement. There's no point complaining to the reader about the word limit of the journal: s/he is not interested in that. This is not the right place for discussing journal policy. The need for summarising content and focussing on key elements of a cohesive argument is fundamental in a world of information overload. A&A/MNRAS/ApJ/PRD letters are generally much worse than normal articles in terms of reproducibility because they have to omit so many details that the reader has to read the full articles to really know what is done. But the reality is that letters get read a lot, because they're short and snappy. --- paper.tex | 2 +- tex/src/appendix-necessity.tex | 2 +- tex/src/supplement.tex | 16 ++++++++-------- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/paper.tex b/paper.tex index 79503f2..08980b4 100644 --- a/paper.tex +++ b/paper.tex @@ -147,7 +147,7 @@ Longevity is defined as the length of time that a project remains \emph{function Functionality is defined as \emph{human readability} of the source and its \emph{execution possibility} (when necessary). Many usage contexts of a project do not involve execution: for example, checking the configuration parameter of a single step of the analysis to re-\emph{use} in another project, or checking the version of used software, or the source of the input data. Extracting these from execution outputs is not always possible.} -A basic review of the longevity of commonly-used tools is provided here \new{(for a more comprehensive review, please see +A basic review of the longevity of commonly used tools is provided here \new{(for a more comprehensive review, please see \ifdefined\separatesupplement the supplementary appendices% \else% diff --git a/tex/src/appendix-necessity.tex b/tex/src/appendix-necessity.tex index 7124223..7db810c 100644 --- a/tex/src/appendix-necessity.tex +++ b/tex/src/appendix-necessity.tex @@ -13,7 +13,7 @@ %% ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or %% FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License %% for more details. See . -\section{Necessity for reproducible research\\(not submitted to journal, here for basic review)} +\section{Necessity for reproducible research\\(not part of journal article; introductory review for non-specialists)} \label{appendix:necessity} The increasing volume and complexity of data analysis has been highly productive, giving rise to a new branch of ``Big Data'' in many fields of the sciences and industry. diff --git a/tex/src/supplement.tex b/tex/src/supplement.tex index 317907d..a1d29c8 100644 --- a/tex/src/supplement.tex +++ b/tex/src/supplement.tex @@ -74,14 +74,14 @@ %% A short appendix describing this file. \begin{abstract} - This supplement contains appendices to accompany the body of the published paper on CiSE (pre-print published on \href{https://arxiv.org/abs/\projectarxivid}{\texttt{arXiv:\projectarxivid}} or \href{https://doi.org/10.5281/zenodo.\projectzenodoid}{\texttt{zenodo.\projectzenodoid}}). - In the paper's main body we discussed criteria for longevity and introduced a proof of concept that implements them called Maneage (\emph{Man}aging data lin\emph{eage}). - However, due to the journal word-count limit we could not include a thorough literature review to emphasis on all the valuable lessons learnt from previous methods or compare them (and their lower-level tools) in sufficient detail to the criteria or the proof-of-concept presented in this work. - Appendix \ref{appendix:existingtools} reviews the low-level tools that used by many (reproducible) workflow solutions (including our proof of concept). - Appendix \ref{appendix:existingsolutions} reviews many solutions that attept(ed) reproducible management of workflows (including solutions that have been abandonded, discontinued, or unavailable any more). - To highlight the evolving landscape and its effects on longevity, Appendix \ref{appendix:existingsolutions} discusses them in historical order. - Finally, in Appendix \ref{appendix:software} an automatically generated, and exaustive, list of software used to build this project is included with their versions. - This supplement was built over project commit \projectversion. + This supplement contains appendices to the main body of the published paper on CiSE (pre-print published on \href{https://arxiv.org/abs/\projectarxivid}{\texttt{arXiv:\projectarxivid}} or \href{https://doi.org/10.5281/zenodo.\projectzenodoid}{\texttt{zenodo.\projectzenodoid}}). + In the paper's main body we discussed criteria for longevity and introduced a proof of concept that implements them, called Maneage (\emph{Man}aging data lin\emph{eage}). + This supplement provides an in-depth literature review of previous methods and compares them and their lower-level tools in detail with our criteria and with the proof of concept presented in this work. + Appendix \ref{appendix:existingtools} reviews the low-level tools that are used by many reproducible workflow solutions (including our proof of concept). + Appendix \ref{appendix:existingsolutions} reviews many solutions that attempt(ed) reproducible management of workflows (including solutions that have stopped development, or worse, are no longer available online). + To highlight the evolving landscape and its effects on longevity, Appendix \ref{appendix:existingsolutions} discusses the solutions in historical order. + Finally, in Appendix \ref{appendix:software} an automatically generated, exhaustive list of software used to build this project is included with the software versions indicated. + This supplement was built from project commit \projectversion. \end{abstract} %% Import the appendices. -- cgit v1.2.1