Skip to content

Commit 5783226

Browse files
committed
minor corrections
1 parent 20eadf4 commit 5783226

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.Rmd

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

21-
**excelDataGuide** simplifies reading data from spreadsheet data reporting templates (DRT's) into R.
21+
**excelDataGuide** is an R-package that 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. 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.
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 enables the *Interoperability*, the **I** of the [FAIR](https://www.go-fair.org/fair-principles/) principles for DRT's.
2424

2525
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

@@ -35,7 +35,7 @@ pak::pak("SystemsBioinformatics/excelDataGuide")
3535

3636
## Example
3737

38-
The basic usage of the package only requires one command with two file paths: the path to the Excel data file and the path to the data guide file. Here is an example:
38+
The basic usage of the package requires only one command with two file paths: the path to the Excel data file and the path to the data guide file. Here is an example:
3939

4040
```{r example}
4141
library(excelDataGuide)

0 commit comments

Comments
 (0)