Skip to content

Commit 908e399

Browse files
committed
Deploying to gh-pages from @ ab1b296 🚀
1 parent e3a9c6d commit 908e399

4 files changed

Lines changed: 39 additions & 19 deletions

File tree

articles/writing_templates_and_data_guides.html

Lines changed: 18 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

articles/writing_templates_and_data_guides.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,20 +89,31 @@ only a major number is invalid, but will be interpreted as having a
8989
minor version 0, *i.e.* a version “2” will be interpreted as “2.0”.
9090

9191
In practice this means that the format of the cell in which the version
92-
number is recorded should be *text*, and not *general* or *number*
92+
number is recorded should formally be *text*, and not *general* or
93+
*number*. However, in the package we do provide functionality to
94+
interpret these fields as version numbers even if the cells in the
95+
template have *general* or *number* format.
9396

94-
**A template name is optional**. Preferably, a template also has a name.
95-
Note that the example in the figure above doesn’t have a name.
97+
In the guide this is referred to as guide.version
98+
99+
**A template name is optional**. Preferably, a template also has a name
100+
as a way for users to refer to it. Note that the example in the figure
101+
above doesn’t have a name.
102+
103+
In the guide this field is referred to as template.name.
96104

97105
**Checking compatibilty of template versions and a guide version**. We
98106
use template version numbers to check compatibility with a guide. In
99107
principle the same guide can be used for multiple versions of a template
100108
as long as the locations and names of variables indexed in the guide did
101-
not change. This is the case when, for example, only explanatory texts
102-
or calculations or data validity checks have changed in the template.
103-
When checking version compatibility we assume that a guide is compatible
104-
with a consecutive range of template versions between a minimal and a
105-
maximal version number.
109+
not change in new template versions. This is the case when, for example,
110+
only explanatory texts or calculations or data validity checks have
111+
changed in the template. When checking version compatibility we assume
112+
that a guide is compatible with a consecutive range of template versions
113+
between a minimal and a maximal version number.
114+
115+
In the guide these version numbers are referred to as
116+
template.min.version and template.max.version.
106117

107118
### All cells are protected except those for data entry
108119

pkgdown.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ pkgdown: 2.2.0
33
pkgdown_sha: ~
44
articles:
55
writing_templates_and_data_guides: writing_templates_and_data_guides.html
6-
last_built: 2026-03-01T11:24Z
6+
last_built: 2026-03-02T08:12Z
77
urls:
88
reference: https://systemsbioinformatics.github.io/excelDataGuide/reference
99
article: https://systemsbioinformatics.github.io/excelDataGuide/articles

search.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)