example datasets
Closed this issue · 0 comments
jonathancallahan commented
In order to have examples that people can run, we need to have some small example datasets that go with the package.
Example data.R
file from our packages include:
- https://github.com/MazamaScience/AirSensor/blob/master/R/data.R
- https://github.com/MazamaScience/MazamaSpatialPlots/blob/master/R/data.R
It is OK to use existing package functionality to create these (no chicken/egg issues) and the documentation should include the precise code used to create an example and the date on which it was run. We're striving for "open-transparent-reproducible".
I like to create example datasets with names that begin with example_~
just so that it is always clear what it is. They also want to be reasonably small so that the package can make it past the CRAN gatekeepers (<1 MB total if possible).
I think we should have the following example datasets:
-
example_fw13Meta
-- Washington state subset of fw13 metadata -
example_wrccMeta
-- Washington state subset of wrcc metadata -
example_fw13<siteName>
-- fw13 timeseries data for 2017? from some place in Eastern Washington with big temperature swings -
example_fw13<siteName>
-- wrcc_timeseries (limited to current month) from the same or a nearby location