You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
this is a bit of a big issue, but just to keep track of what should be factored out:
the rmarkdown template (for the mail) strictly should not do any work, but should merely define the presentation of results (i.e. the order of tables and perhaps some commentary).
Among other things, the rmarkdown template currently creates the excel output, which makes this quite brittle (and required the hack-fix for send attachment #44
the substantive documentation in the template (i.e. what this or that means, not just "hello"-boilerplate) should be in the roxgen2 documentation for the respective functions.
We can then figure out a way to dynamically pull this into the rmarkdown template.
(I know that it's easily possible to pull in random rmarkdown chunks into the roxygen docs, but it would be even more expressive to do it the other way around -- will have to investigate).
The logic here is that this kind of info really belongs to the functions, where it can be maintained together, tested, etc.
no dependencies in rmarkdown templates, in particular, or at least not without programmatically rendereing the template as part of the check.
If there is a missing dependency as in https://github.com/subugoe/metacheck/actions/runs/413556533 this creates a pretty thorny failure mode, because the missing dep isn't captured by R CMD check.
simply no r code that isn't a function and isn't covered by at least R CMD check and friends, ideally test() as well.
tbc.
The text was updated successfully, but these errors were encountered:
this is a bit of a big issue, but just to keep track of what should be factored out:
We can then figure out a way to dynamically pull this into the rmarkdown template.
(I know that it's easily possible to pull in random rmarkdown chunks into the roxygen docs, but it would be even more expressive to do it the other way around -- will have to investigate).
The logic here is that this kind of info really belongs to the functions, where it can be maintained together, tested, etc.
If there is a missing dependency as in https://github.com/subugoe/metacheck/actions/runs/413556533 this creates a pretty thorny failure mode, because the missing dep isn't captured by
R CMD check
.R CMD check
and friends, ideallytest()
as well.tbc.
The text was updated successfully, but these errors were encountered: