|
6 | 6 | <!-- badges: start --> |
7 | 7 | <!-- badges: end --> |
8 | 8 |
|
9 | | -**excelDataGuide** simplifies reading data from Excel data reporting |
10 | | -templates (DRT’s) into R. |
| 9 | +**excelDataGuide** simplifies reading data from spreadsheet data |
| 10 | +reporting templates (DRT’s) into R. |
11 | 11 |
|
12 | 12 | A data reporting template is an Excel file for standardized reporting |
13 | | -and processing of experimental data. The template encourages or forces |
14 | | -users to provide data in a structured manner that minimizes errors and |
15 | | -misinterpretation. |
| 13 | +and processing of experimental data. Such templates reduce the time |
| 14 | +spent on data analysis and encourage or force users to provide data in a |
| 15 | +structured manner so that errors and misinterpretations are minimized. |
| 16 | +The **excelDataGuide** package avoids the problem of having to write and |
| 17 | +maintain code to read data from complicated spreadsheet DRT’s. |
| 18 | +Furthermore, it provides an infrastructure to check the validity of |
| 19 | +data, to read data in the correct data types and to wrangle data when |
| 20 | +appropriate or desired. It thereby facilitates enables the |
| 21 | +*Interoperability*, the **I** of the |
| 22 | +[FAIR](https://www.go-fair.org/fair-principles/) principles for DRT’s. |
16 | 23 |
|
17 | 24 | The package provides a simple interface to read data from Excel files |
18 | 25 | and convert them into R objects. We assume that data is organized in |
19 | | -three types of data structures; key-value pairs, tabular data and |
| 26 | +three types of data structures: key-value pairs, tabular data and |
20 | 27 | microplateplate-formatted data. The locations of these data structures |
21 | | -in the Excel template are provided by a **data guide**. A data guide is |
22 | | -a YAML file designed for a specific data reporting template. |
| 28 | +in the Excel template are provided by a **data guide**, which is a YAML |
| 29 | +file, a human- as well as machine-readable structured file format. |
23 | 30 |
|
24 | 31 | ## Installation |
25 | 32 |
|
|
0 commit comments