@@ -21,30 +21,33 @@ library(excelDataGuide)
2121
2222## Introduction
2323
24- The spreadsheet is a widely used tool in the biochemical laboratory, both for
25- recording and analyzing experiments. When such experiments become a routine we
26- often create spreadsheet templates to save time and to structure our work.
27-
28- The goal of the excelDataGuide package is to be able to use Excel spreadsheets
29- as well as scripts as data analysis tools. Clearly, a scripting language
30- has more potential when it comes to analyzing large data sets, consisting of
31- multiple notebooks.
32-
33- Importantly, ** the source of all data is the spreadsheet.** This concerns
34- metadata, parameters like acceptance criteria, concentrations and measured data.
35- This * one-source* policy guarantees that calculations in the spreadsheet and in
36- the scripts are all based on the same underlying data and parameters.
37-
38- Parameters, like acceptance criteria, are determined in the SOP and fixed
39- in the spreadsheet template, whereas other data may vary per experiment and is
40- entered by the user. For example, when a user performs parameter fitting, it may
41- be useful to compare the fitted parameters to those obtained in another
42- programming environment.
43-
44- Concerning calculated data it may or may not be useful to let the spreadsheet be
45- the source of such data for the script as well. This may be particularly useful
46- when it concerns calculations that are carried out automatically upon entry
47- of data by the user.
24+ Spreadsheets are widely used in biochemical laboratories for both recording and
25+ analyzing experiments. When experiments become routine, spreadsheet templates
26+ are often created to streamline workflows and ensure consistency.
27+
28+ The goal of the ** excelDataGuide** package is to enable the use of Excel
29+ spreadsheets alongside scripting environments as effective data analysis tools.
30+ While scripting languages offer more flexibility and power—especially for
31+ analyzing large datasets across multiple workbooks—the spreadsheet remains the
32+ ** primary source of all data** .
33+
34+ This ** "single-source-of-truth"** approach ensures that both spreadsheet-based
35+ and script-based analyses rely on the same underlying data and parameters.
36+ This includes:
37+
38+ - ** Metadata**
39+ - ** Experimental parameters** (e.g., acceptance criteria, concentrations)
40+ - ** Measured data**
41+
42+ Parameters such as acceptance criteria are typically defined by standard
43+ operating procedures (SOPs) and fixed in the spreadsheet templates. Other
44+ values, such as experimental measurements or fitted parameters, vary per
45+ experiment and are entered by the user.
46+
47+ In some cases, it may be beneficial for the script to also use
48+ ** calculated data** from the spreadsheet—especially when those calculations are
49+ automatically triggered upon user input. This decision depends on the specific
50+ analysis needs and the reliability of spreadsheet-based computations.
4851
4952## Structuring a template
5053
0 commit comments