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

Bug 18330: type argument documentation in install.packages #43

Open
shannonpileggi opened this issue Aug 9, 2024 · 1 comment
Open
Labels
Documentation Issues in the documentation needs patch Implement the agreed fix and prepare a patch for review RSECon24

Comments

@shannonpileggi
Copy link

Bug 18330: type argument documentation in install.packages

The current documentation for the type argument to install.packages has the following:

Possible values of type are (currently) "source", "mac.binary", and "win.binary": the appropriate binary type where supported can also be selected as "binary".

This is inaccurate for a few reasons:

There are other possible values of type, specifically "mac.binary.XXXXX" where XXXXX defines a build name. (e.g. mac.binary.big-sur-arm64 for M1 macs on Big Sur or newer).
"mac.binary" only installs the High Sierra x86_64 build, even on other systems.
The documentation is implying that "mac.binary" and "binary" are equivalent options, which they are not.
I suggest reframing this such that "source" and "binary" are presented as the two primary options, with a follow-up discussion about the various "YYY.binary.ZZZZZ" options if something goes wrong and a different version is installed.

(There may be additional issues/corrections needed for Windows but I'm not a Windows user.)
@shannonpileggi shannonpileggi added Documentation Issues in the documentation needs patch Implement the agreed fix and prepare a patch for review Hutch 2024 Issues reserved for R Dev Day @ Hutch 2024 labels Aug 9, 2024
@hturner hturner added RSECon24 and removed Hutch 2024 Issues reserved for R Dev Day @ Hutch 2024 labels Aug 22, 2024
@mikerspencer
Copy link

Suggested replacement text:

Possible values of type are (currently) "source" or "binary", with the latter available for Windows or Mac.
The "binary" argument takes the form of "win.binary" or "mac.binary.*", where * defines the Mac build name.
The appropriate binary type where supported can also be selected as "binary".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues in the documentation needs patch Implement the agreed fix and prepare a patch for review RSECon24
Projects
None yet
Development

No branches or pull requests

3 participants