Improve documentation of tdor data

[hturner]

Make sure we have good description of each variable. Include a simple example. Is a reference the right way to note the source?

[annajayne]

If it would help, I'd be happy to update the readme.md for the CSV repo on BitBucket to include data on what each column represents and the data type. Would that help?

[hturner]

That would be good, as it would help anyone that gets the data from Bitbucket (not everyone uses R!).

You can see what we have at the moment in https://github.com/CaRdiffR/tdor/blob/master/R/tdor.R. Most variables are obvious (or they are variables we created ourselves), I think the main questions to clear up are:

• Is it just the first line of Description that goes on memorial cards, or the first paragraph? How should the rest of that field be formatted? We might split this up into separate variables.
• What is TGEU ref?
• What is Source?

[annajayne]

I'm not sure what "Source" is but it's likely a typo - can you point me at where in the data it appears?

"TGEU ref" is a deprecated field which has just been replaced by "Source ref" in the CSV data on Bitbucket.

It's basically a string which shows where to find the corresponding entry in the corresponding TDoR list. If it's blank, it means that the entry doesn't appear (or hasn't yet) in a TDoR list.

[hturner]

"Source" has been fixed, it was supposed to be "Description".

"TGEU ref" (and "Source Ref") are now merged with "Source ref" when the data is prepared for the package, but a PR has been made to correct these in the Bitbucket source.

The documentation has been updated with the variable descriptions. Adding an example can be a separate issue.