From 3d04e6826e9d36873f3bad94583f03715800b629 Mon Sep 17 00:00:00 2001 From: Marcel Ramos Date: Tue, 23 Jan 2024 07:50:19 -0500 Subject: [PATCH] minor formatting and spell check updates (#115) --- deprecation.Rmd | 7 ++++--- r-code.Rmd | 4 ++-- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/deprecation.Rmd b/deprecation.Rmd index 206f035..4a826eb 100644 --- a/deprecation.Rmd +++ b/deprecation.Rmd @@ -138,15 +138,16 @@ necessary. After the promise object has been saved, we update the documentation to reflect the changes and provide additional details and resources for -users as necessary. It is recommended to include a "[Deprecated]" label in the -data documentation title. +users as necessary. It is recommended to include a "[Deprecated]" label +in the data documentation title. ### Step 3 - Defunct the dataset In the following release cycle, you can update the warning message to indicate that the dataset is defunct and remove it entirely from the promise object i.e., from the expression in the `delayedAssign` function. We can also update -the "[Deprecated]" label in the documentation title to "[Defunct]". +the "[Deprecated]" label in the documentation title to +"[Defunct]". ## How to Deprecate a Package {#deprecate-package} diff --git a/r-code.Rmd b/r-code.Rmd index ccead3e..b5054dc 100644 --- a/r-code.Rmd +++ b/r-code.Rmd @@ -265,10 +265,10 @@ highly encouraged. ## R Code Best Practices and Guidelines -Many common coding and sytax issues are flagged in `R CMD check` and +Many common coding and syntax issues are flagged in `R CMD check` and `BiocCheck()` (see the `R CMD check` [cheatsheet](http://r-pkgs.had.co.nz/check.html) and `r BiocStyle::Biocpkg("BiocCheck", vignette = "BiocCheck.html")` vignette. Every -effort should be made to clear up ERROR, WARNING, or Notes produced from these +effort should be made to clear up ERROR, WARNING, or NOTEs produced from these checks. ### Code syntax and efficiency