Skip to content

Commit 78ba63f

Browse files
committed
using image of sheet instead of text
1 parent 6385025 commit 78ba63f

File tree

2 files changed

+6
-21
lines changed

2 files changed

+6
-21
lines changed

README.md

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,25 @@
11
# dataSheetParcr
22

3-
A small R package that contains a parser for data sheets. It is currently used to parse our google sheets with the BioSB curriculum. The parser was constructed with the [`parcr`](https://CRAN.R-project.org/package=parcr) package
3+
A small R package that contains a parser for data sheets. It is currently used to parse our google sheets with the BioSB curriculum. The parser was constructed with the [`parcr`](https://CRAN.R-project.org/package=parcr) package
44

55
## Installation
66

77
Install with
8-
```r
8+
9+
``` r
910
# install.packages("pak")
1011
pak::pak("SystemsBioinformatics/dataSheetParcr")
1112
```
1213

1314
## Usage
15+
1416
The package exports only one function: `parse_sheet()`, which parses one sheet and returns a list of named tables. The structure of a data sheet should be as follows
1517

16-
```
17-
# Comment rows start with a hash in the left most cell
18-
# Blank lines are ignored, also if they contain tabs
19-
# The name of a table is printed above a table behind the > symbol
20-
# A table starts with a column header row in the left-most cell of a line
21-
22-
> name_of_table
23-
# more optional comments or blank lines
24-
var1 var2 var3
25-
1 2 3
26-
4 5 6
27-
28-
# more comments if needed
29-
> other_table
30-
var5 var6 var7
31-
1 2 3
32-
4 5 6
33-
```
18+
<img src="data-raw/images/example_in_excel.png" alt="excel sheet" style="width:450px;"/>
3419

3520
This sheet will be parsed by `parse_sheet()` and returns a list object with two named `tibble` objects:
3621

37-
```
22+
```
3823
$name_of_table
3924
# A tibble: 2 × 3
4025
var1 var2 var3
52.1 KB
Loading

0 commit comments

Comments
 (0)