presenting modelling methods

[goldingn]

There was a suggestion at our coding club that a guide could provide tips on how to report the methods used in the analysis. E.g. the number of datapoints, covariates, modelling methods and parameters, and the packages and modules (and their versions) used.

There could also be an output module to help automate this.

[Doi90]

Possibly work into Reproducibility guide

[Doi90]

Currently working on an output module (MethodsReport, open to name suggestions) to do this. Output will be a list of data related things (# observations/presences/absences/background etc), system info (OS + R version), a citation for zoon, and citations for all of the modules called.

Is there a way to pass the session.info and moduleVersions variables from the workflow into an output module? I'd prefer not to duplicate code if I can.

If not, session.info could be easily replicated inside the module, but I think moduleVersions will run into problems since it would still need the module names passed into it still.

Alternatively, instead of a module (the ideal scenario IMO) it could be turned into a function in the zoon package instead. Run something like MethodsReport(myWorkflow). Keeping it as a module makes the whole zoon process more self-contained though.

[goldingn]

The short answer is no, that information isn't available to output modules.

That's something we could change on our hacking session though.