add updates to documentation to resolve installation issues - #64
add updates to documentation to resolve installation issues#64joshuafayallen wants to merge 1 commit into
Conversation
|
Thanks very much, Josh! (I assume you are not the QB of the Bills...) @mcaceresb can you review and merge if you think appropriate |
|
No worries! Lol I would love that pay bump |
| .Ruserdata | ||
| .DS_Store | ||
|
|
||
| /.quarto/ |
There was a problem hiding this comment.
Is quarto required for this fix?
| install.packages('remotes') | ||
| # install from github | ||
| remotes::install_github("asheshrambachan/HonestDiD") | ||
|
|
There was a problem hiding this comment.
Why blank line? This is present in a few code chunks.
|
|
||
| ``` | ||
|
|
||
| Your installation may fail if the C++ headers are not configured correctly and you may see something to this effect. |
There was a problem hiding this comment.
Something like this?
Some of HonestDiD's dependencies are known to cause installation issues on some systems. If the C++ headers are not configured correctly, for example, you may see an error similar to:
| make: *** [foo.o] Error 1 | ||
|
|
||
| ``` | ||
| To resolve this issue you should consult the [rstan installation page](https://github.com/stan-dev/rstan/wiki/Configuring-C---Toolchain-for-Mac) which will configure the C++ toolchain properly. After modifying the `makevars` file be sure to restart your R session. |
There was a problem hiding this comment.
Change
which will configure
to something similar to
and follow the applicable instructions to configure
(since the page doesn't configure anything; it has instructions).
| make: *** [foo.o] Error 1 | ||
|
|
||
| ``` | ||
| To resolve this issue you should consult the [rstan installation page](https://github.com/stan-dev/rstan/wiki/Configuring-C---Toolchain-for-Mac) which will configure the C++ toolchain properly. After modifying the `makevars` file be sure to restart your R session. |
There was a problem hiding this comment.
What is the makevars file?
| ``` | ||
| To resolve this issue you should consult the [rstan installation page](https://github.com/stan-dev/rstan/wiki/Configuring-C---Toolchain-for-Mac) which will configure the C++ toolchain properly. After modifying the `makevars` file be sure to restart your R session. | ||
|
|
||
| If all else fails then you can simply turn off warnings which will install the package without configuring the C++ toolchain. |
There was a problem hiding this comment.
Why is there a downside to doing this? We should include a note explaining the gains from doing the above.
3 participants
Hi All,
I was installing the package and found that the issue related to installation ARM Macs may have had to with issues related to not having C++ headers correctly since
CVXR's dependencies rely on RCPPThis pull request simply updates the documents to point users in the right direction to resolve this issue.