Convert IRangesOverview.Rnw to IRangesOverview.Rmd
@jwokaty please review this PR I have reviewed it once using the checklist and make sure that R CMD build contains html. After your review we will ask @hpages for final review.
Note: The plots position is quite different in the html document but I believe that in the pdf plots are appeared at the middle of the code blocks which is not possible to generate in html the current position of plots look good to me.
We will be using this checklist to review my PR I have reviewed it myself, Please review my changes and let me know if any more changes are required any suggestion will be appreciated.
Note: During the review I noticed that pdf has
> if (!require("BiocManager"))
+ install.packages("BiocManager")
> BiocManager::install("IRanges")
I Remember that One of the requirements of a vignette is that it must not install anything without the user's knowledge. But the code label uses eval=FALSE to stop running that code chunk so I think there is no problem.
- [x] the
.Rmdfile knits toHTML - [x]
R CMD buildruns without errors or timeouts - [x] the tarball from
R CMD buildcontains theHTML(check with the following by substituting the package name and vignette nametar ztf package_name.tar.gz | grep 'doc/vignette_name') - [x] the
.Rnwfile has been removed - In the
DESCRIPTIONfile- [x]
BiocStyleandknitrare listed inSuggests - [x] the line
VignetteBuilder: knitrexists - [x] any added lines use the same spacing and indents as the existing document
- [x]
- If agreed with the Maintainer
- [x] the contributor is in the author list in the
DESCRIPTIONfile*. - [x] the contributor is in the author list in the vignette's YAML*.
- [x] the contributor is in the author list in the
- If this pull request involves converting from separate
AuthorandMaintainerlines to theAuthors@Rvector, please ensure that- [x] the
Authors@Rvector includes the maintainer as specified withrole='cre'. - [x] the
Maintainerline is completely removed.
- [x] the
- [x]
HTMLdocument is representative of thePDFin content and in general the presentation - [x] Where the contributor was not able to preserve the content and presentation
of the
PDFis noted as a comment in the pull request - [x] the R Markdown file is representative of the Sweave document and follows
best practices, such as replacing links to Bioconductor packages with calls
to BiocStyle's
Biocpkg() - [x] Only files necessary for the conversion are included in the pull request.
- [x] Long lines have been broken up and reformatted, you can achieve this by
selecting the text in your script and then clicking on
Code > Reflow Commentin R Studio. - [x] Code blocks are surrounded by a blank line, and there are no blank lines before the start or after the end of the code within the code block.
- Refer to the contribution guide for acceptable formats
@jwokaty, thank you for your thorough review. I have incorporated all of your suggested changes, except for this one. Please inform me if any further modifications are needed.