openrefine data model

[Mathieu Saby]

Hi

I'm trying to understand Openrefine data model from the wiki page https://github.com/OpenRefine/OpenRefine/wiki/Variables

I made for myself a schema. It's just a draft, and not sure it is accurate, but I share it with you...

Do you think something like that could be useful in the documentation?

https://www.lucidchart.com/documents/view/1c65e7e3-0ac6-4aa6-bde1-65b3d9abb702

(by the way: recon.candidates is discribed as "an object encapsulating the default 3 candidates". Maybe it was the case before, but now the candidates can be more than 3)

M. Saby

[Owen Stephens]

Hi Mathieu,

I like this and think the diagram (or something like it) could be a useful addition to the documentation.

Owen

[Mathieu Saby]

Thanks
I made some corrections (for record object).
I put in red the commands that can be directly used in expressions.
Not sure of how to represent the list of columns in cells object and the list of arrays in recordCells...

[Owen Stephens]

In terms of highlighting in red the commands that can be used directly - I think there are a few more?

columnNames

record

index

etc. etc.

[Mathieu Saby]

You cannot use "record" alone in an expression (it gives "null") while you can use "value" or "cells.XXX". That's what I meant...

[Owen Stephens]

Ah - ok.

I'm not convinced that the diagram is going to be the easiest way to get that across - 'cells' only really works because it is a shortcut to row.cells etc. I'd say it's more that all the paths work but some have shortcuts?

That said, if highlighting helps others I'm not against it!

Owen