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

doc: document R CRAN mirror process #10211

Closed
wants to merge 1 commit into from

Conversation

lholmquist
Copy link
Contributor

Checklist
  • [x ] documentation is changed or added
  • [ x] commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

The current benchmark docs showing how to install R packages
doesn't go into how to specify a CRAN mirror.

This PR adds 3 options on how to install the needed packages
when a CRAN mirror is asked for.

fixes: #10204

@nodejs-github-bot nodejs-github-bot added dont-land-on-v7.x benchmark Issues and PRs related to the benchmark subsystem. labels Dec 10, 2016
@AndreasMadsen
Copy link
Member

I would prefer just a single safe option, I think half a page of install instructions is kinda scary for the reader.

$ R
options(menu.graphics = FALSE)
install.packages("ggplot2")
install.packages("plyr")

or

$ R
install.packages("ggplot2", repo="http://cran.us.r-project.org")
install.packages("plyr", repo="http://cran.us.r-project.org")

should be sufficient.

@lholmquist
Copy link
Contributor Author

@AndreasMadsen yea, that makes sense, i'll probably use the second option

@lholmquist
Copy link
Contributor Author

@AndreasMadsen ok, updated and rebased

@AndreasMadsen
Copy link
Member

LGTM. To be clear you should get that message on all platforms, but some may show it as an X11 window, which is what causes the problems.

@lholmquist
Copy link
Contributor Author

@AndreasMadsen should i change the heading then? or leave as is?

@AndreasMadsen AndreasMadsen added the doc Issues and PRs related to the documentations. label Dec 12, 2016
@AndreasMadsen
Copy link
Member

@lholmquist You could change it to CRAN mirror or something similar.

@lholmquist
Copy link
Contributor Author

@AndreasMadsen ok, updated and rebased

install.packages("ggplot2", repo="http://cran.us.r-project.org")
```

Of course, use the mirror that suites your location.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: 'suits your location'

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

The current benchmark docs showing how to install R packages
doesn't go into how to specify a CRAN mirror.

This commit shows how to specify the repo parameter when
installing a package.

fixes: nodejs#10204
@lance
Copy link
Member

lance commented Dec 15, 2016

Landed in: eceef76

@lance lance closed this Dec 15, 2016
lance pushed a commit that referenced this pull request Dec 15, 2016
The current benchmark docs showing how to install R packages
doesn't go into how to specify a CRAN mirror.

This commit shows how to specify the repo parameter when
installing a package.

Fixes: #10204
PR-URL: #10211
Reviewed-By: Andreas Madsen <[email protected]>
italoacasas pushed a commit that referenced this pull request Dec 17, 2016
The current benchmark docs showing how to install R packages
doesn't go into how to specify a CRAN mirror.

This commit shows how to specify the repo parameter when
installing a package.

Fixes: #10204
PR-URL: #10211
Reviewed-By: Andreas Madsen <[email protected]>
@italoacasas italoacasas mentioned this pull request Dec 17, 2016
cjihrig pushed a commit that referenced this pull request Dec 20, 2016
The current benchmark docs showing how to install R packages
doesn't go into how to specify a CRAN mirror.

This commit shows how to specify the repo parameter when
installing a package.

Fixes: #10204
PR-URL: #10211
Reviewed-By: Andreas Madsen <[email protected]>
@MylesBorins
Copy link
Contributor

This does not land cleanly in LTS. Added dont-land label. Please feel free to manually backport

@AndreasMadsen
Copy link
Member

It should not be backported, the entire benchmark suite was rewritten in v7 and declared a major change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
benchmark Issues and PRs related to the benchmark subsystem. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Benchmark docs: how to select the CRAN Mirror for R
5 participants