lc-open-refine
lc-open-refine copied to clipboard
LibraryCarpentry
Create a GREL cheatsheet
Create a cheatsheet-like handout for GREL functions with examples.
This should include at least all GREL operations used in the Lesson The desired end result is a cheat sheet such as
- https://github.com/LibraryCarpentry/lc-data-intro/blob/gh-pages/reference.md OR
- https://www.cheatography.com/davechild/cheat-sheets/regular-expressions/ (more ambitious)
Resources in the OpenRefine wiki may be helpful in compiling the guide and also may be worth pointing to from the cheat sheet. In particular:
- https://github.com/OpenRefine/OpenRefine/wiki/General-Refine-Expression-Language
- https://github.com/OpenRefine/OpenRefine/wiki/Recipes
I have created a GREL cheatsheet for this in my teachingfiles repo: https://github.com/weaverbel/teachingfiles/blob/master/grel_value_replace.md
Comments very welcome !
Thanks @weaverbel. For me, in relation to the library carpentry material, this is more detail than I envisaged for a cheat sheet. I had in mind a single sheet of A4 that covered a whole range of GREL functions but in less detail than you have here.
That said - this is a very thorough and clearly useful document.
What do others think? @libcce @pitviper6 @ccronje
Thanks x2 @weaverbel. @ostephens can this be a subset/a category (i.e. working with strings) in the single sheet that you were thinking of?
@libcc for me (and just my opinion!) I'd be looking to illustrate the general syntax of replace with maybe one replace string example and one replace regular expression example.
Anything that we feel is lacking in the underlying OpenRefine documentation - we can just add to the OpenRefine wiki - I'd really want to avoid us doing things that are compensating for poor documentation in the OR wiki - we should improve the documentation instead :)
The reason I made the sheet so explicit is so people don't have to go hunting for specific things they want to do and get frustrated in the process, especially when trying to create a regex in OR where the syntax is tricky. People just want really clear examples they can copy. We could cut this down a bit as it is a bit long. I have also got some other cheats for string split and other GREL commands - still refining those though. I am happy for stuff to go in the wiki but we may as well get the bugs out of it here first.
Given that the OpenRefine documentation has been significantly improved since this issue was created, and can be easily linked to (e.g. for replace -> https://docs.openrefine.org/manual/grelfunctions/#replaces-s-or-p-find-s-replace) I'd suggest that this issue can be closed - unless there are any objections?
Possibly agree. I hope we have time to discuss this 11/18, too. After this week's Maintainer meeting about the transition to Workbench, it looks like there will be a place for a lesson-specific handout, in addition to a glossary of terms used in the lesson. The demo site shows the glossary and "More" in the top banner. Zhian will present to Midwest Big Data Hub on Monday where I can follow up about the automated vs. manual elements of this part of the transition.
Potentially we could look at creating separate issues in readiness for the workbench:
- Create/prepare glossaries (https://preview.carpentries.org/r-socialsci/reference.html#glossary)
- Create/prepare handouts (https://preview.carpentries.org/r-socialsci/intro-R-handout.html)
If anyone has suggestions for which GREL functions are most important for the learners in this lesson, please add them to these comments.