help files in general

[florianhartig]

a comment about the help - when I was writing the unit tests now, I realized that the help does not do a good job in showing the context in which functions are being used.

Take as example plotLPJData - this function requires running getLPJData first, but this is nowhere documented, it just says that the input variable x is an LPJData object.

A good help should have

• a link to getLPJData in the help of x
• a link to getLPJData with the @Seealso tag
• a shared help file that shows both functions in context, see also comment in example files #39

see, for example, ?DHARMa::plot.DHARMa

[Rasilgon]

OK. thanks for checking! It is a good point.
I assumed that if x is a LPJData object, then its clear that before getLPJData or runLPJ must have been previoulsy callled to create the LPJData object. In general, besides runLPJ and setupLPJ there is no much context provided.
I am going trough the help files and will add info in @details and context in @examples.

[Rasilgon]

On branch develop I improved help files with examples (inst/examples) and provided context of use that connects functions and shows work flow.