Skip to content

Commit 63e1ceb

Browse files
committed
implement comments from Mihail
thanks!
1 parent 2b6831b commit 63e1ceb

3 files changed

Lines changed: 10 additions & 4 deletions

File tree

lib/metadata.tex

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
\author[1]{Miroslav Kratochvíl}
33
\author[2]{St.~Elmo Wilken}
44
\author[3,4,5,6]{Andreas Dräger}
5+
\author[7]{Mihail Anton}
56
\author{Please Add Yourself Here}
67
%\author[999]{Please add yourself if you contribute}
78
\affil[1]{Luxembourg Centre for Systems Biomedicine, University of Luxembourg, LU}
@@ -10,5 +11,6 @@
1011
\affil[4]{Department of Computer Science, Eberhard Karl University of Tübingen, 72076 Tübingen, DE}
1112
\affil[5]{German Center for Infection Research (DZIF), partner site Tübingen, DE}
1213
\affil[6]{Cluster of Excellence `Controlling Microbes to Fight Infections,' Eberhard Karl University of Tübingen, 72076 Tübingen, DE}
14+
\affil[7]{Department of Life Sciences, National Bioinformatics Infrastructure Sweden, Science for Life Laboratory, Chalmers University of Technology, SE-41296 Gothenburg, SE}
1315
%\affil[999]{Please add your affiliation if you contribute}
1416
\date{\today}

text/spec.tex

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ \subsection{TSV}
109109
\subsubsection{Numeric and special values in TSV files}
110110
\emph{Numeric} fields must be converted to decimal representation. The decimal representation may include a leading minus sign, decimal point, and an integer exponent separated by \verb|e| (for example, valid encodings of $-1234.5\times10^2$ include \verb|-123450|, \verb|-12.345e4|, and \verb|-12345000e-2|). Rounding of non-representable and infinite numbers may be performed, but it should preserve the outcome of the report comparison, as described in~\cref{sec:cmpdata}.
111111

112-
Missing numeric values must be represented by an empty string. Missing values typically occur when a value is expected in a field (such as in the place of the optimal value of the model), but it can not be computed for some reason (such as model infeasibility).
112+
Missing numeric values must be represented by an empty field. Missing values typically occur when a value is expected in a field (such as in the place of the optimal value of the model), but it can not be computed for some reason (such as model infeasibility).
113113

114114
\emph{Solver status} fields contain a special value that describes the outcome of an optimization algorithm. FROG currently describes only two kinds of statuses:
115115
\begin{itemize}
@@ -167,13 +167,17 @@ \subsection{Metadata file}
167167
& optional
168168
& URL of a website or public repository where the model is developed, preferably offering a chance to contact the model authors or submit corrections of the model
169169
\\
170+
\verb|model_reproducibility_url|
171+
& optional
172+
& URL of a website or a public repository that gives closer information on how to reproduce the results obtained using the model, such as a link to a reproducible notebook or to a test suite
173+
\\
170174
\verb|model_version|
171175
& optional
172176
& version string of the model, if available
173177
\\
174178
\verb|environment|
175179
& required
176-
& free-text description of the software environment used to run FROG analysis tools, such as from \verb|uname -a|
180+
& free-text description of the software and hardware environment used to run FROG analysis tools, such as the versions of operating system, the hardware platform and the software tools; if possible, this includes a pointer to a machine-readable information that reproduces the environment, such as a versioned docker image name, or a version-lock file for a package management system
177181
\\
178182
\verb|software|$\to$\verb|frog|
179183
& required

text/test.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ \section{Metadata comparison}
7171
\midrule
7272
\verb|frog_version|
7373
& consistent
74-
& generated report semantics may differ
74+
& generated report semantics may differ among incompatible FROG versions; consistency may be checked with respect to semantic versioning~\cite{semver}
7575
\\
7676
\verb|frog_id|
7777
& informative
@@ -99,7 +99,7 @@ \section{Metadata comparison}
9999
\\
100100
\verb|model_version|
101101
& consistent
102-
& compared models likely differ
102+
& compared models of different versions likely differ; consistency may be checked with respect to semantic versioning~\cite{semver}
103103
\\
104104
\verb|environment|
105105
& informative

0 commit comments

Comments
 (0)