dfe-analytical-services / eesyapi

An R package with useful utility functions for connecting to, and processing data from, the DfE's explore education statistics API.
https://dfe-analytical-services.github.io/eesyapi/
Other
1 stars 0 forks source link

Give specific example of using download dataset as a preview function #48

Closed cjrace closed 1 month ago

cjrace commented 1 month ago

Is your feature request related to a problem? Please describe.

Had a suggestion of a preview_dataset() function that is effectively

download_dataset("id....") |> head()

Describe the solution you'd like

Quickest option will be to make it clearer in the download_dataset section of the main workflow vignette that it should be seen as a preview function, and encourage the piping into head() to limit the rows in memory.

Describe alternatives you've considered

Considering making a quick preview_dataset() function, though thought that might be overkill for now. Especially as currently we can't do anything other than pull in the whole data set in the original query, so we could be requesting millions of rows and then filtering that down to only saving a handful of them.

Additional context

None.

Lsnaathorst1 commented 3 weeks ago

Analysts guide: add link to ADA jargon buster