Update code in vignette to reflect package dependencies?

[hrdawson]

Hello,

I'm mostly an end user of R. Could you update the code in your vignette to make it easier for less technical people like myself to install this very useful package? Trying to install the package using the code given in the vignette just gives me an extended error message.

> remotes::install_github("DrylandEcology/rSFSW2")
Downloading GitHub repo DrylandEcology/rSFSW2@HEAD
Skipping 3 packages not available: rSW2funs, rSW2utils, rSOILWAT2
✓  checking for file ‘/private/var/folders/0c/wk35hq9j5_31wrch0xr3_bh00000gn/T/RtmpiKHV3L/remotes1e8e3ea3eb6f/DrylandEcology-rSFSW2-efdd60e/DESCRIPTION’ (391ms)
─  preparing ‘rSFSW2’: (388ms)
✓  checking DESCRIPTION meta-information ...
─  cleaning src
─  installing the package to process help pages (367ms)
         -----------------------------------
   ERROR: dependencies ‘rSOILWAT2’, ‘rSW2utils’, ‘rSW2funs’ are not available for package ‘rSFSW2’
─  removing ‘/private/var/folders/0c/wk35hq9j5_31wrch0xr3_bh00000gn/T/RtmpnZJab0/Rinst20d58ed72c3/rSFSW2’
         -----------------------------------
   ERROR: package installation failed
Error: Failed to install 'rSFSW2' from GitHub:
  System command 'R' failed, exit status: 1, stdout + stderr:
E> * checking for file ‘/private/var/folders/0c/wk35hq9j5_31wrch0xr3_bh00000gn/T/RtmpiKHV3L/remotes1e8e3ea3eb6f/DrylandEcology-rSFSW2-efdd60e/DESCRIPTION’ ... OK
E> * preparing ‘rSFSW2’:
E> * checking DESCRIPTION meta-information ... OK
E> * cleaning src
E> * installing the package to process help pages
E>       -----------------------------------
E> ERROR: dependencies ‘rSOILWAT2’, ‘rSW2utils’, ‘rSW2funs’ are not available for package ‘rSFSW2’
E> * removing ‘/private/var/folders/0c/wk35hq9j5_31wrch0xr3_bh00000gn/T/RtmpnZJab0/Rinst20d58ed72c3/rSFSW2’
E>       -----------------------------------
E> ERROR: package installation failed

Debugging this, I've sorted out that each of the four packages (‘rSOILWAT2’, ‘rSW2utils’, ‘rSW2funs’, ‘rSFSW2’) need to installed in a particular order: 1. ‘rSW2utils’, 2. ‘rSOILWAT2’, 3. ‘rSW2funs’, and finally 4. ‘rSFSW2’. It would be very helpful if you could note this in the vignette for those of us who are mostly end users of R.

Thank you and I look forward to using this package!
Hilary Rose

[dschlaep]

Thanks for the useful suggestion!

I would consider a PR if you write up your suggestion to enhance the vignette.

Maybe also check out the development branch reorganize_rSW2 where I started using the remotes package to make it easier to correctly install dependencies.