Skip to content

Commit ac6fb82

Browse files
committed
update README
1 parent faf09de commit ac6fb82

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

README.Rmd

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,9 @@ locations:
101101
We provide a json schema for the data guide, allowing you to check the validity of
102102
guides that you wrote. The schema is available in the package as
103103
`system.file("extdata", "excelguide_schema.json", package = "excelDataGuide")`. To
104-
check its validity against the schema you can use the [Polyglottal JSON Schema Validator](https://www.npmjs.com/package/pajv).
104+
check its validity against the schema you can use the [Polyglottal JSON Schema Validator](https://www.npmjs.com/package/pajv). More details can be found in the vignette (to be done, see below).
105105

106106
## Future work
107107

108-
We want to provide guide and template structures for data types without upper size limit, typically time series with no pre-determined length.
108+
- Complete the vignette ([issue](https://github.com/SystemsBioinformatics/excelDataGuide/issues/2))
109+
- Provide guide and template structures for data types without upper size limit, typically time series with no pre-determined length ([issue](https://github.com/SystemsBioinformatics/excelDataGuide/issues/1)).

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,13 @@ validity of guides that you wrote. The schema is available in the
134134
package as
135135
`system.file("extdata", "excelguide_schema.json", package = "excelDataGuide")`.
136136
To check its validity against the schema you can use the [Polyglottal
137-
JSON Schema Validator](https://www.npmjs.com/package/pajv).
137+
JSON Schema Validator](https://www.npmjs.com/package/pajv). More details
138+
can be found in the vignette (to be done, see below).
138139

139140
## Future work
140141

141-
We want to provide guide and template structures for data types without
142-
upper size limit, typically time series with no pre-determined length.
142+
- Complete the vignette
143+
([issue](https://github.com/SystemsBioinformatics/excelDataGuide/issues/2))
144+
- Provide guide and template structures for data types without upper
145+
size limit, typically time series with no pre-determined length
146+
([issue](https://github.com/SystemsBioinformatics/excelDataGuide/issues/1)).

0 commit comments

Comments
 (0)