Skip to content

Commit 20eadf4

Browse files
committed
Merge branch 'main' into development
merge modifications to README
2 parents 4687e61 + a15dcae commit 20eadf4

2 files changed

Lines changed: 18 additions & 11 deletions

File tree

README.Rmd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ knitr::opts_chunk$set(
1818
<!-- badges: start -->
1919
<!-- badges: end -->
2020

21-
**excelDataGuide** simplifies reading data from Excel data reporting templates (DRT's) into R.
21+
**excelDataGuide** simplifies reading data from spreadsheet data reporting templates (DRT's) into R.
2222

23-
A data reporting template is an Excel file for standardized reporting and processing of experimental data. The template encourages or forces users to provide data in a structured manner that minimizes errors and misinterpretation.
23+
A data reporting template is an Excel file for standardized reporting and processing of experimental data. Such templates reduce the time spent on data analysis and encourage or force users to provide data in a structured manner so that errors and misinterpretations are minimized. The **excelDataGuide** package avoids the problem of having to write and maintain code to read data from complicated spreadsheet DRT's. Furthermore, it provides an infrastructure to check the validity of data, to read data in the correct data types and to wrangle data when appropriate or desired. It thereby facilitates enables the *Interoperability*, the **I** of the [FAIR](https://www.go-fair.org/fair-principles/) principles for DRT's.
2424

25-
The package provides a simple interface to read data from Excel files and convert them into R objects. We assume that data is organized in three types of data structures; key-value pairs, tabular data and microplateplate-formatted data. The locations of these data structures in the Excel template are provided by a **data guide**. A data guide is a YAML file designed for a specific data reporting template.
25+
The package provides a simple interface to read data from Excel files and convert them into R objects. We assume that data is organized in three types of data structures: key-value pairs, tabular data and microplateplate-formatted data. The locations of these data structures in the Excel template are provided by a **data guide**, which is a YAML file, a human- as well as machine-readable structured file format.
2626

2727
## Installation
2828

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,27 @@
66
<!-- badges: start -->
77
<!-- badges: end -->
88

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.
1111

1212
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.
1623

1724
The package provides a simple interface to read data from Excel files
1825
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
2027
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.
2330

2431
## Installation
2532

0 commit comments

Comments
 (0)