add different functions that users/developers can use to install a package

[k-doering-NOAA]

Is your feature request related to a problem? Please describe.
Specify the differences between remotes::install_github(), devtools::install_local(), and devtools::load_all() and also - we can speed up install off r-universe and should make this clear to users with the following README text and a badge showing the deployed version: https://ropensci.org/blog/2021/06/22/setup-runiverse/

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Tasks

Preview Give feedback

1. describe differences between remotes and devtools install methods
2. add a note to install from r-universe

[ChristineStawitz-NOAA]

also @Bai-Li-NOAA @Cole-Monnahan-NOAA discovered you can't install from a branch from runiverse so this should be included in the instructions we write up

[k-doering-NOAA]

also @Bai-Li-NOAA @Cole-Monnahan-NOAA discovered you can't install from a branch from runiverse so this should be included in the instructions we write up

Technically, we could tell R universe to build a branch instead of the default branch, but I'm not sure if you could have a branch (or branches) and main available, so I agree with Bai and Cole that it isn't really feasible.

Another note is R universe only offers the current version of the software and does not archive any older versions.

[JonBrodziak]

It would be helpful to provide rationale on which installation method best fits a particular user scenario.

[iantaylor-NOAA]

As discussed during seaside chat, the command to install from R-universe
remotes::install_cran("FIMS", repos = "https://noaa-fims.r-universe.dev/")

[kellijohnson-NOAA]

How to install the package should be in the user guidance not development guidelines. If we want people to install from R universe instead of GitHub, it should be the instructions on the readme. I do agree that a badge for the R universe presence would be great.

We already have a note in the handbook for using devtools::load_all() here.

[kellijohnson-NOAA]

We should NOT use devtools::load_all() for FIMS ever. It leads to an unclean space and things going out of scope. Thanks to @msupernaw finding this explanation of shims, which is causing the problem.

load_all() also inserts shim functions into the imports environment of the loaded package. It presently adds a replacement version of system.file which returns different paths from base::system.file. This is needed because installed and uninstalled package sources have different directory structures. Note that this is not a perfect replacement for base::system.file.

All guidance regarding the use of load_all() needs to be removed from the collaborative workflow and a warning that it should not be used should be explicitly included somewhere.