setup_package() unexpected changes to _pkgdown.yml

[hansvancalster]

When using setup_package() to update an existing R package (i.c. inbospatial), it made unexpected updates to my _pkgdown.yml.

Here is a screenshot:

At first it also errored with "old-style organisation.yml" detected (I deleted that file from the package root to fix this).

[ThierryO]

Can you provide a link to the code with the problem?

[hansvancalster]

Can you provide a link to the code with the problem?

Not really, since I haven't pushed that problem. I discarded the changes made by checklist. But the PR is inbo/inbospatial#20. And this commit has the changes I did keep for pkgdown.yml. And this commit can show you the organisation.yml file that I had to delete because of the "old-style organisation.yml" error.

[hansvancalster]

You can probably reproduce the problem by running checklist::setup_package() again on the next-version branch of inbospatial (?).

[ThierryO]

Let me explain the changes. checklist creates a default _pkgdown.yml. The idea is that you can revert unwanted changes. The long list of organisations will only have an effect on the pkgdown website in case you actually add them to the authors. Therefore I didn't bother to add code the find out what organisation you actually use in the package.

[hansvancalster]

That's good to know. I leave it up to you to close the issue or not. It might be confusing to other people as well, in which case it would make sense to add code that removes the organisations from _pkgdown.yml that are not used in the package. Not a high priority...

[ThierryO]

Maybe we should have the function return a message with instruction on how to handle the changes in _pkgdown.yml

[hansvancalster]

Yes, that's another good option.