Skip to content

Commit cc4f8ad

Browse files
authored
Link to devel branch and spelling fixes (#123)
* link to devel branch * spelling fixes
1 parent 7a1224c commit cc4f8ad

File tree

8 files changed

+17
-15
lines changed

8 files changed

+17
-15
lines changed

_output.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ bookdown::bs4_book:
44
yellow: "#804600"
55
h4-font-size: "1.1rem"
66
headings-color: "#87b13f"
7-
repo: https://github.com/Bioconductor/pkgrevdocs
7+
repo:
8+
base: https://github.com/Bioconductor/pkgrevdocs
9+
branch: devel
810
# Refer to https://rstudio.github.io/bslib/articles/bs4-variables.html for theme variable names
911

1012
bookdown::pdf_book:

description-file.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ data. There are of course exceptions; please provide reasoning if included.
9292
All packages must be available via [_Bioconductor_'s biocViews][biocViews] or
9393
[CRAN][CRAN pkgs]; the use of the `Remotes:` field is not supported, hence dependencies only
9494
available on other repositories (e.g. <i class="fab fa-github"></i> GitHub) are
95-
not allowed nor is specifiy an explicit version of a package.
95+
not allowed nor is specify an explicit version of a package.
9696

9797
Reuse, rather than re-implement or duplicate, well-tested functionality from
9898
other packages. Make use of appropriate existing packages (e.g.,

documentation.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ If appropriate, we strongly encourage a table of contents
116116

117117
### Evaluated code chunks
118118

119-
Non-trival executable code is a must!!!
119+
Non-trivial executable code is a must!!!
120120

121121
Static vignettes are not acceptable.
122122

package-data.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ mailing list.
3535

3636
See the [Package Submission guidelines](#bioconductor-package-submissions) for
3737
further submission procedures and if submitting related or circular dependent
38-
packages please read [releated package submission procedure][cirdep]
38+
packages please read [related package submission procedure][cirdep]
3939

4040
## Adding Data to Existing Package {#adding-data-to-existing-package}
4141

package-submission.Rmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ AnnotationDbi.
225225

226226
Annotation packages should *NOT* be posted to the tracker repository.
227227
Instead send an email to <[email protected]> with a
228-
description of the proposed annotation package and futher instructions
228+
description of the proposed annotation package and further instructions
229229
of where to send the package will be provided. Whenever possible Annotation
230230
Packages should use the `r BiocStyle::Biocpkg("AnnotationHub")` for managing
231231
files.
@@ -296,13 +296,13 @@ use of existing data in a Bioconductor package. See development section on
296296
* If in the pre-review process there are identified larger issues with the
297297
package, a label `3e. pending pre-review changes` or a more specific flag of
298298
package issue will be assigned. Please address any pre-review identified
299-
issues and comment back for the package admininstrators to re-evaluate.
299+
issues and comment back for the package administrators to re-evaluate.
300300

301301
* Once your package builds and checks without errors or (avoidable)
302302
warnings, the package is assigned a reviewer. The package will be
303303
labelled `2. Review in progress`.
304304

305-
* The reviewr will provide a technical review of your package. Other
305+
* The reviewer will provide a technical review of your package. Other
306306
_Bioconductor_ developers and users with domain expertise are encouraged to
307307
provide additional community commentary. Reviewers will add comments to the
308308
issue you created.
@@ -314,7 +314,7 @@ use of existing data in a Bioconductor package. See development section on
314314
* Respond to the issues raised by the reviewers. You _must_ respond to
315315
the primary reviewer, and are strongly encouraged to consider
316316
community commentary. Typically your response will involve code
317-
modifications; commit these to the default branch of git.bioconductororg. When
317+
modifications; commit these to the default branch of git.bioconductor.org. When
318318
you have addressed all concerns, add a comment to the issue created in step 2
319319
to explain your response.
320320

r-code.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ checks.
284284
* Do not use `browser()` in any internal <i class="fab fa-r-project"></i> code.
285285
* Avoid the use of `<<-`.
286286
* Avoid use of direct slot access with `@` or `slot()`. Accessor methods should be created and utilized
287-
* Use the packages `r BiocStyle::Biocpkg("ExperimentHub")` and `r BiocStyle::Biocpkg("AnnotationHub")` instead of downloading external data from unsanctioned providers such as <i class="fab fa-github"></i> GitHub, <i * class="fa fa-dropbox" aria-hidden="true"></i> Dropbox, etc. In general, data utlilzed in packages should be downloaded from trusted public databases. See also section on web querying and file caching.
287+
* Use the packages `r BiocStyle::Biocpkg("ExperimentHub")` and `r BiocStyle::Biocpkg("AnnotationHub")` instead of downloading external data from unsanctioned providers such as <i class="fab fa-github"></i> GitHub, <i * class="fa fa-dropbox" aria-hidden="true"></i> Dropbox, etc. In general, data utlilized in packages should be downloaded from trusted public databases. See also section on web querying and file caching.
288288
* Use `<-` instead of `=` for assigning variables except in function arguments.
289289

290290
### Cyclomatic Complexity

review-expectations.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ not accept the issue until both packages are in an accepted state.
5353
## Expectations and deadlines {.unnumbered #review-expectations-and-deadlines}
5454

5555
Package[s] will be expected to be reviewed within 3 weeks of assignment and
56-
producea clean build report from the build machine. We plan to make a hard
56+
produce a clean build report from the build machine. We plan to make a hard
5757
limit for 3 weeks. If the delay is on the submitter, the issue will be closed
5858
for inactivity; it will be reopened when a submitter can commit to timely
5959
updates and engagement of the review process. If the delay is in the reviewer,
@@ -97,7 +97,7 @@ package they can request someone offer additional comments (including those not
9797
officially part of the package review list) without explicitly asking for
9898
reassignment.
9999

100-
Frequent requests for reassignement should consider a longer leave of absence
100+
Frequent requests for reassignment should consider a longer leave of absence
101101
agreement with the package review administrator. If frequent requests are being
102102
made for reassignement the reviewer will be notified and at risk for being
103103
removed from the active review process. If a reviewer is removed, they must

troubleshoot-build-report.Rmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ with a valid version bump.
2727

2828
## How do I reproduce the build system ERROR?
2929

30-
In order to reproduce the ERROR's accuately locally, remember to be using the
30+
In order to reproduce the ERROR's accurately locally, remember to be using the
3131
correct version of R and Bioconductor. The version of R used for the build
3232
report can be found at the top of the [release][release-software-build-report] and
3333
[devel][devel-software-build-report] build reports. Once you are using the
@@ -103,8 +103,8 @@ R switched from 3.x to 4.0 which generally means some significant changes.
103103
- [Scalar / Vector Logic](#scalarvec)
104104
- [Class == vs is/inherits](#classEq)
105105
- [Matrix is now Array](#matarr)
106-
- [data.frame stringAsFactors](#stringsAsFactors)
107-
- [stats::smoorthEnds](#statsSmoothEnds)
106+
- [data.frame stringsAsFactors](#stringsAsFactors)
107+
- [stats::smoothEnds](#statsSmoothEnds)
108108
- [grid package changes](#grid)
109109
- [plot generic moved](#plot)
110110
- [Partial Argument Matching](#partMatch)
@@ -381,7 +381,7 @@ these packages; when they are available, they will be added.
381381
CRAN packages are occasionally removed. Unfortunately, Bioconductor will only
382382
allow package dependencies to be actively maintained packages on CRAN or Bioconductor.
383383
A package will have to alter their package to not utilize code and not rely on this
384-
dependency. You may of course try to pentition CRAN for reinstatement or reach
384+
dependency. You may of course try to petition CRAN for reinstatement or reach
385385
out to the package maintainer to fix and submit to CRAN. Good Luck!
386386

387387
#### Package has been removed from Bioconductor

0 commit comments

Comments
 (0)