Documentation for user-visible functions

[erex]

@dill
It seems there are only three user-facing functions. This is the first challenge of the documentation; a neophyte is presented with a list of 35 entries in the help TOC. When first trying to get to grips, they don't know which of those doors to open.

Quick thoughts about documentation of those central functions

• convert_project(): lacks an Example section, Details picks an odd topic to discuss (model names)
• run_analysis(): does have an Example; again odd second paragraph of details
• test_stats(): notes that results are "scaled, relative", perhaps describe what that means, could you not say proportional difference? Should tolerance argument and the last figure in Value section not be the same?
• converted_distance_analyses: while not a function, is central to the user because this the product they will wish to manipulate. env is central to this--folks won't have used environments very much (I certainly haven't). I believe it is incorrect to say env only contains an obs.table object.

How do you want to proceed with changes to the documentation? Should I have a go and you can clean up after me?

[dill]

Thanks for consolidating this @erex

I'd suggest that we flesh out the readdst-package help page and point to the three functions you mention here. I also suggest we cover the structure of the converted analysis object either there or in a separate help file, references in readdst-package.

Very happy for you to take a first run at it.

[erex]

Above issue, partially addressed by 511e865 and 54429e8

[dill]

Thanks for this Eric, these look good. 8f80fab re-reoxygens to update the .Rd files.