Ogiles joss refactor docs

[OscartGiles]

Summary

• Update documentation
• Make functions internal
• Add examples to functions

Issues

• Addresses item 3 from https://github.com/alan-turing-institute/DetectorChecker/issues/110
• Addresses item 1 and 2 from https://github.com/alan-turing-institute/DetectorChecker/issues/111

[OscartGiles]

Ok signing off for the night. I've been though the docs for about half the functions. Will do the remaining on Tuesday.

In the meantime, there are a few functions I wasn't sure about. Could you advise @tomaslaz ?

Outstanding:

Update the docs description for this.. I've made it internal. Is that ok? https://github.com/alan-turing-institute/DetectorChecker/blob/7aca81531d0a57e6e631c71186cc57ce07505668/R/clump.R#L283-L291

Update docs. Needs a detailed description of the algorithm and examples (see https://github.com/alan-turing-institute/DetectorChecker/issues/111) https://github.com/alan-turing-institute/DetectorChecker/blob/48630e63bec4f94e5d1a9c48f1f1a05314d45950/R/clump.R#L255-L281

Document glm_* functions. Not sure what incl_event_list should be https://github.com/alan-turing-institute/DetectorChecker/blob/48630e63bec4f94e5d1a9c48f1f1a05314d45950/R/clump.R#L534

https://github.com/alan-turing-institute/DetectorChecker/blob/48630e63bec4f94e5d1a9c48f1f1a05314d45950/R/clump.R#L551

https://github.com/alan-turing-institute/DetectorChecker/blob/48630e63bec4f94e5d1a9c48f1f1a05314d45950/R/clump.R#L568

https://github.com/alan-turing-institute/DetectorChecker/blob/48630e63bec4f94e5d1a9c48f1f1a05314d45950/R/clump.R#L585

https://github.com/alan-turing-institute/DetectorChecker/blob/48630e63bec4f94e5d1a9c48f1f1a05314d45950/R/clump.R#L602

https://github.com/alan-turing-institute/DetectorChecker/blob/48630e63bec4f94e5d1a9c48f1f1a05314d45950/R/clump.R#L619