ceff-tech / ffc_api_client

An R client for the online Functional Flows Calculator API
https://ceff-tech.github.io/ffc_api_client
9 stars 3 forks source link

Installation documentation not complete #60

Open kklausmeyer opened 3 years ago

kklausmeyer commented 3 years ago

I am a new R user and I have a new computer, so I'm installing this for the first time on this machine. I hit two bumps that were not mentioned in the documentation:

  1. In order to install the ffcAPIClient, I got a warning that I had not installed RTools yet, however, it went forward with installing some packages, so it was confusion. Consider adding RTools as a pre-requirement for installation in the documentation.
  2. After installing Rtools, I got a warning saying that the package rlang was missing. Consider adding install.packages('rlang') as a pre-requirement for installation in the documentation.
nickrsan commented 3 years ago

Hi Kirk,

Thanks for the notes. RTools is not required for installation of these packages since we don't need C/C++ code built and R will download the binary versions of other packages. I've been trying to keep the list of steps as short as possible, so I'll probably add a note for people that they may get a warning about installing RTools, but they don't need to do so for this package in order to reduce confusion.

I'm surprised you got the warning about installing rlang - installing devtools installs rlang typically - it's not a dependency of our code. The RTools message suggests to me you're running on Windows - can you tell me what version of Windows, what version of R, and what version of devtools you're running? That'll help me figure out what's going on and if we should cahnge anything in our install process. Since you said you're new to R, let me know if you want info on finding any of that.

Thanks!

kklausmeyer commented 3 years ago

Hi Nick- thank you for the quick reply. I'm using

I'm not sure how to check my devtools version, but I just installed it yesterday, so I assume it is the most recent version.