-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add FAQ #26 #51
Add FAQ #26 #51
Conversation
@schochastics Please chip in. |
vignettes/faq.Rmd
Outdated
* `dockerize()` can only generate Debian/Ubuntu-based Docker images | ||
* `dockerize(cache = TRUE)` does not cache [R source code](https://cran.r-project.org/src/base/) (yet) and System Requirements (in `deb` packages) | ||
* `query_sysreqs()` (as well as `resolve(query_sysreqs = TRUE)`) queries for System Requirements based on the latest version of the packages on CRAN / Github. Therefore: | ||
* Archived CRAN packages are assumed to have no System Requirements |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe Removed CRAN packages
is a better term.
|
||
# Docker questions | ||
|
||
**DQ1: Is Docker an overkill to simply ensure that a few lines of R code are reproducible?** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To make the wording like this might irritate someone
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe something like "Is docker really necessary to simply ensure..."
vignettes/faq.Rmd
Outdated
|
||
**GA3:** It is because we optimize the R code in `rang.R` for backward compatibility. We need to make sure that the code runs well in vanilla R environments since 2.1.0. | ||
|
||
**GQ4: Why doesn't `rang` support R < 2.1.0 yet?** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
reconstructing
|
||
**GQ2: For running `resolve()`, how do I know which packages are used in a project?** | ||
|
||
**GA2:** We recommend `renv::dependencies()`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe mention that this only works with CRAN packages? That is, it doesnt tell you if a package comes from github
|
||
**GQ3: Why is the R script generated by `dockerize()` and `export_rang()` so strange/unidiomatic/inefficient/did you guys read `fortunes::fortune("answer is parse")`?** | ||
|
||
**GA3:** It is because we optimize the R code in `rang.R` for backward compatibility. We need to make sure that the code runs well in vanilla R environments since 2.1.0. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe add something in the line of "you better not edit it anyway"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
apart from the few comments I left, I think it is very good.
Should we add a detailed section on a comparison with other package?
I feel like your mentions of others should be already adequate
@schochastics Thanks a lot! |
No description provided.