datacamp / datacamp/rdocumentation-2.0
[bug] FindMyFriends documentation outdate
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 301
- Forks
- 54
- Avg merge
- 16h 19m
- Merged PRs (30d)
- 1
Description
The documentation on how to install the package is outdated. It should be update as follows.
Documentation entry
GitHub README
Observed behavior
FindMyFriends is an R package for doing pangenomic analyses on microbial genomes. It is released as part of the Bioconductor project and can be installed with the biocLite() function:
source("https://bioconductor.org/biocLite.R")
biocLite("FindMyFriends")
Expected behavior
FindMyFriends is an R package for doing pangenomic analyses on microbial genomes. It is released as part of the Bioconductor project and can be installed with the BiocManager::install() function:
if (!requireNamespace("BiocManager", quietly=TRUE))
install.packages("BiocManager")
BiocManager::install("FindMyFriends")
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the Documentation entry with the GitHub README and locate the installation instructions for FindMyFriends. Replace the outdated biocLite() example with the BiocManager::install() instructions shown in the issue, then verify that the rendered documentation presents the current installation steps.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100