Possible error in GREL documentation for cell reference

jquartel · May 31, 2024, 1:26pm

At the top of the GREL documentation ('Syntax' section) is a table that shows:

FirstName.cells | Access the cell in the column named “FirstName” of the current row

but I don't think this works. Doesn't it need to be cells.FirstName ?

thadguidry · May 31, 2024, 1:40pm

yeap. or if it's spaced. cells["First Name"]
See Expressions | OpenRefine

jquartel · May 31, 2024, 1:47pm

Yes the table has that (spaced) example.

So it is an error, yes? I'll submit to the github issues.

thadguidry · May 31, 2024, 2:01pm

Why not just fix it with a PR on this
Click Link

github.com

OpenRefine/openrefine.org/blob/518ebd84c2f63dde227298bb3972447c47b11d8c/docs/manual/grel.md?plain=1#L69


      
          |-|-|
          | `value.trim().length()` | `length(trim(value))` |
          | `value.substring(7, 10)` | `substring(value, 7, 10)` |
          
          So, in the dot shorthand, the functions occur from left to right in the order of calling, rather than in the reverse order with parentheses. This allows you to string together multiple functions in a readable order.
          
          The dot notation can also be used to access the member fields of [variables](expressions#variables). For referring to column names that contain spaces (anything not a continuous string), use square brackets instead of dot notation:
          
          |Example |Description |
          |-|-|
          | `FirstName.cells` | Access the cell in the column named “FirstName” of the current row |
          | `cells["First Name"]` | Access the cell in the column called “First Name” of the current row |
          
          Square brackets can also be used to get substrings and sub-arrays, and single items from arrays:
          
          |Example |Description |
          |-|-|
          | `value[1,3]` | A substring of value, starting from character 1 up to but excluding character 3 |
          | `"internationalization"[1,-2]` | Will return “nternationalizati” (negative indexes are counted from the end) |
          | `row.columnNames[5]` | Will return the name of the fifth column |

Tap your e key to edit the file.
Make changes
Commit changes - top right (it will ask you to fork the repo and make a PR)
Create PR

ostephens · June 3, 2024, 1:37pm

Fixed. See Incorrect syntax used in GREL syntax example · Issue #344 · OpenRefine/openrefine.org · GitHub

thadguidry · June 3, 2024, 1:54pm

Darn, you took all the fun away from @jquartel

jquartel · June 5, 2024, 4:59pm

Ha, no I'm very happy for others to be fixing the source Thanks all!

Topic		Replies	Views
GREL function previews ok, then fails Data cleaning and transformations	4	330	April 27, 2023
Is there a GREL function to alphabetically compare strings? Support	14	238	February 3, 2024
GREL for exact word matching between columns Data cleaning and transformations	1	181	November 8, 2023
Blank result for a long GREL expression parsing XML data Support	3	219	November 26, 2023
xmlText() not working (like htmlText()) Support	2	162	November 14, 2023

Possible error in GREL documentation for cell reference

Related Topics