IRanges icon indicating copy to clipboard operation
IRanges copied to clipboard

Convert IRangesOverview.Rnw to IRangesOverview.Rmd

Open sonali8434 opened this issue 2 years ago • 2 comments

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

Attached PDF HTML for your reference.

sonali8434 avatar Jun 13 '23 19:06 sonali8434

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 .Rmd file knits to HTML
  • [x] R CMD build runs without errors or timeouts
  • [x] the tarball from R CMD build contains the HTML (check with the following by substituting the package name and vignette name tar ztf package_name.tar.gz | grep 'doc/vignette_name')
  • [x] the .Rnw file has been removed
  • In the DESCRIPTION file
    • [x] BiocStyle and knitr are listed in Suggests
    • [x] the line VignetteBuilder: knitr exists
    • [x] any added lines use the same spacing and indents as the existing document
  • If agreed with the Maintainer
    • [x] the contributor is in the author list in the DESCRIPTION file*.
    • [x] the contributor is in the author list in the vignette's YAML*.
  • If this pull request involves converting from separate Author and Maintainer lines to the Authors@R vector, please ensure that
    • [x] the Authors@R vector includes the maintainer as specified with role='cre'.
    • [x] the Maintainer line is completely removed.
  • [x] HTML document is representative of the PDF in content and in general the presentation
  • [x] Where the contributor was not able to preserve the content and presentation of the PDF is 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 Comment in 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

sonali8434 avatar Jun 13 '23 19:06 sonali8434

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

sonali8434 avatar Jun 16 '23 05:06 sonali8434