fix r cmd check note about #! interpreter line

[jgabry]

Fixes #82.

Checks if first line is #! interpreter line and if so puts the "don't edit by hand" message on the second line instead of the first. This avoids the new r cmd check note reported in #82.

[bgoodri]

This is good, but does anything that was grepping for "do not edit this file" foolishly assume that such a line could only appear at the top of the file?

[jgabry]

Hmm, that's definitely something we could have foolishly done but I don't actually think we are grepping for that anywhere. I may have missed it though. Where would we need to do that?

[bgoodri]

There are various functions somewhere that check for that line and if it doesn't exist then they throw a warning but don't overwrite the file.

…

On Wed, Dec 2, 2020 at 1:01 PM Jonah Gabry ***@***.***> wrote: Hmm, that's definitely something we could have foolishly done but I don't actually think we are grepping for that anywhere. I may have missed it though. Where would we need to do that? — You are receiving this because your review was requested. Reply to this email directly, view it on GitHub <#83 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZ2XKSFMNARYGI3U72XROTSSZ6I3ANCNFSM4UKYEMIQ> .

[jgabry]

Ah ok yeah. I'll check on that.

[jgabry]

@bgoodri You were right. In two places I just changed:

readLines(dest_file, n = 1) == noedit_msg

to

noedit_msg %in% readLines(dest_file, n = 5)

[mlysy]

The proposed fix should be fine. I'm pretty sure I was just checking the first line each time.

More long-term, the current auto_config mechanism strikes me as less than ideal.

First of all, .warning_nooverwrite() in R/rstan_package_utils.R issues a warning if existing files won't be overwritten. But files such as src/Makevars may need to be modified depending on the developer's needs. Since auto_config = TRUE runs rstan_config() during installation, this will issue an R CMD check warning such that auto_config needs to be disabled. A quick fix is to change the warning to a message.

A second less important issue is that it's cumbersome to change the structure of the package based on whether or not auto_config is enabled.

What I was thinking instead was to create a hook to run rstan_config() as part of devtools::document(). It seems possible to do this with roxygen, but I haven't experimented much with this approach.

[jgabry]

@mlysy Thanks, yeah I think changing the auto_config mechanism like sounds good if you want to try that out.