Add a guide on how to update the internal data

gesistsa · Sep 8, 2023 · 628c3e1 · 628c3e1
1 parent 1378503
commit 628c3e1
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/Makefile b/Makefile
@@ -8,10 +8,12 @@ NAMESPACE: R/*
 README.md: README.Rmd
 	Rscript -e "knitr::knit('README.Rmd')"
 
+R/sysdata.rda: data-raw/single.json
+	Rscript data-raw/convert.R
 README.html: README.md
 	pandoc -o README.html README.md
 
-../$(pkg)*.tar.gz: DESCRIPTION NAMESPACE README.md R/* man/* tests/testthat/* po/R-rio.pot
+../$(pkg)*.tar.gz: DESCRIPTION NAMESPACE README.md R/* man/* tests/testthat/* po/R-rio.pot R/sysdata.rda
 	cd ../ && R CMD build $(pkg)
 
 build: ../$(pkg)*.tar.gz

diff --git a/data-raw/readme.md b/data-raw/readme.md
@@ -0,0 +1,11 @@
+
+Please edit the json file if you have made change related to formats.
+
+`convert.R` will prettify the json file as well as regenerate the internal data (`R/sysdata.rda`)
+
+If you prefer, you can also use the `Makefile`
+
+```R
+make R/sysdata.rda
+```
+