openwashdata-dev / washr

An R package to make publishing openwashdata resources easier
https://openwashdata-dev.github.io/washr/
Other
1 stars 0 forks source link

Function: set up dictionary and roxygen documentation #3

Closed mianzg closed 4 months ago

mianzg commented 4 months ago

@margauxgo

I am still adding tests. But I think it's good to go if you can help to try the two functions setup_dictionary() and setup_roxygen().

Once the raw data is imported and the data-processing.R is complete with exporting tidy data to data/ folder. (If any of the above is not done, the following execution should throw an error message)

You can set up a dictionary by executing washr::setup_dictionary(). The dictionary csvfile will be stored in the data-raw/ directory and only the column description is empty.

Then you can document the dataset by executing washr::setup_roxygen().

Any suggestion to the function documentation is welcome as always.

margauxgo commented 4 months ago

@mianzg I just tried installing the package again and keep getting this error message again and again

Screenshot 2024-05-15 at 19 54 45
mianzg commented 4 months ago

@mianzg I just tried installing the package again and keep getting this error message again and again

Screenshot 2024-05-15 at 19 54 45

We resolved it by restarting the R session.

margauxgo commented 4 months ago

@mianzg

I made some changes to the documentation as well! Also, I got the following error when exporting the data with readr::write_csv(ugabore, here::here("inst", "extdata", paste0(ugabore, ".csv"))) and openxlsx::write.xlsx(...)

Error in if (is_url(path)){ : the condition has length > 1

so I had to write "ugabore.csv" instead of paste0(ugabore, ".csv") and the same with .xlsx