Skip to content
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

Merged
merged 2 commits into from
Feb 15, 2023
Merged

Add FAQ #26 #51

merged 2 commits into from
Feb 15, 2023

Conversation

chainsawriot
Copy link
Collaborator

No description provided.

@chainsawriot
Copy link
Collaborator Author

@schochastics Please chip in.

* `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
Copy link
Collaborator Author

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?**
Copy link
Collaborator Author

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

Copy link
Member

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..."


**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?**
Copy link
Collaborator Author

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()`.
Copy link
Member

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.
Copy link
Member

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"?

Copy link
Member

@schochastics schochastics left a 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

@chainsawriot chainsawriot merged commit 614943c into v0.1 Feb 15, 2023
@chainsawriot
Copy link
Collaborator Author

@schochastics Thanks a lot!

@chainsawriot chainsawriot deleted the vig branch March 8, 2023 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants