Usage docs about r-iq-oq

[brucemoran]

Hi Mark,

thanks for the reply.

I did have a proverbial 'quick scan' of the .rnw file before posting, it does specify some of the above so apologies for not investigating more fully, but also very glad to have it in writing from yourself.

I will fork and build out for my own purposes.

It is very helpful to have any kind of template for this procedure, so thanks for that.

Bruce.

[marcschwartz]

Hi Bruce,

Thanks for your comments/questions here.

There was never really an intention to package this code for a formal release on CRAN or elsewhere. It was really intended to be a publicly available, proof of concept, implementation that could then serve as the substrate for a more formalized workflow by anyone that needed this functionality. There was also a consideration that this workflow may then have to be customized to some extent to conform to specific local SOPs or other considerations, as may be apropos.

Local SOPs might also require, for example, that database interfaces be tested, or known local results from test datasets and analytic methods be replicated, and so on, which would be outside of the scope of this work. Albeit, a user could add those into the workflow, if desired, or run those separately, which ever pathway makes sense for them.

A key consideration here was to be able to use the default resources and functionality that would be available via a standard installation of R, including Sweave and the suite of built-in tests/regression tests provided, where the latter would either be part of a standard R install from a OS-specific binary on CRAN, or installed separately if one is building R from source.

The exception to the prior comments would be the need to install a LaTeX distribution to generate the resultant PDF report, if one was not already installed.

Thus, this would all be run before installing any other third party R packages via CRAN or elsewhere, such that those added components would not impact in any way, the results of the testing.

The basic instructions for use are in the README file, primarily noting that all of the CMDFile*.r files and the R-IQ-OQ.Rnw file need to be in the same folder/directory to run the code, with additional details and notes in the R-IQ-OQ.Rnw itself, just below the copyright header and before the LaTeX document class statement.