Improved documentation on the OccDet object(s)

BiologicalRecordsCentre / sparta

Species Presence/Absence R Trends Analyses

http://biologicalrecordscentre.github.io/sparta/index.html

MIT License

21 stars 24 forks source link

Improved documentation on the OccDet object(s) #79

Closed drnickisaac closed 5 years ago

drnickisaac commented 6 years ago

New users have complained that the contents of the OccDet object are not clear. In particular, they don't know how to interpret the parameters in the BUGS output.

[x] Add some extra text under the return section in OccDetFunc and OccDetModel to unpack the key elements (and relate them to the literature).
[ ] Add example of how to extract these, and their meanings (copy from the help dock), to the vignette

JHHatfield commented 5 years ago

occDetModel already references occDetFunc so documentation of occDetFunc has been added to.

AugustT commented 5 years ago

I'm closing this as the unchecked task is a replication of a point in the larger documentation issue