Skip to content

Commit 8c7bae9

Browse files
authored
Fix typos (#174)
1 parent 25ee223 commit 8c7bae9

5 files changed

Lines changed: 9 additions & 9 deletions

File tree

build-check-bioccheck.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ version.
77

88

99
The package should `R CMD build`, `R CMD check`, and `BiocCheck` without ERROR.
10-
See useful tools like [devools][] and [BiocCheck][] for more information.
10+
See useful tools like [devtools][] and [BiocCheck][] for more information.
1111

1212

1313
As Bioconductor moves towards integration with

docs/package-review-checklist.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Example: Seurat and data.frames are not Bioconductor classes. Packages certainly
4444
may keep this interoperability and generality but they should also be able to work
4545
_directly_ with the equivalent Bioconductor class in this case likely a SummarizedExperiment or
4646
SingleCellExperiment (maybe with a designed wrapper function, e.g). The majority
47-
of documentation and runnable code should emphasize/demonstarte the interaction
47+
of documentation and runnable code should emphasize/demonstrate the interaction
4848
with Bioconductor objects (it may be in addition to the others capabilities).
4949

5050

@@ -73,7 +73,7 @@ Refer to the [DESCRIPTION](https://contributions.bioconductor.org/description.ht
7373
- [ ] `URL` field.
7474
- [ ] `Video` field. Optional.
7575
- [ ] `Collate` field. Optional.
76-
- [ ] `BiocType` field. (one of: Softare, ExperimentData, Annotation, Workflow, Book)
76+
- [ ] `BiocType` field. (one of: Software, ExperimentData, Annotation, Workflow, Book)
7777
- [ ] `Config/Bioconductor/UnsupportedPlatforms`. Optional. If package designed NOT to work on a specific OS
7878
- [ ] Use of Remotes is NOT allowed. All packages must be on CRAN/Bioconductor
7979

@@ -92,7 +92,7 @@ strongly encouraged. Using both Authors@R and Maintainer/Author is not allowed!
9292
- [ ] Selective imports using `importFrom` instead of *import all* with `import`. Except where appropriate (like class structures and extensions or heavily utilized packages)
9393
- [ ] Individual functions/methods are exported instead of regular expression matching all.
9494
- [ ] NAMESPACE and DESCRIPTION Depends/Imports/Suggests/Enhances consistency.
95-
- [ ] Avoid names of packages, functions, and classes that already exist in Bioconductor infrastrure or could be easily confused
95+
- [ ] Avoid names of packages, functions, and classes that already exist in Bioconductor infrastructure or could be easily confused
9696

9797
## The NEWS file
9898

documentation.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ the order that they are displayed on the package homepage and when the
8282
`browseVignettes()` function is called. Vignettes will show up in
8383
alphabetical order, which may not be a logical ordering without
8484
further specification. One approach to controlling the order of the
85-
vignettes is to use a number in the `VignettteIndexEntry` setting,
85+
vignettes is to use a number in the `VignetteIndexEntry` setting,
8686
e.g. using numbers `1-9`, if you have a single digit number of
8787
vignettes, or `01-99` if you have ten or more vignettes. For example,
8888
the first vignette could specify in the header:
@@ -129,7 +129,7 @@ objective, models, unique functions, key points, etc that distinguish the
129129
package from other packages in the same area. This is a requirement of
130130
Bioconductor package vignettes. It should include a short motivation for the
131131
package in general as well as motivation for inclusion of the package in
132-
Biconductor. When relevant, a brief review and comparison of packages with
132+
Bioconductor. When relevant, a brief review and comparison of packages with
133133
similar functionality or scope should be provided either in the Introduction or
134134
in a separate dedicated vignette section.
135135

index.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,6 @@ knitr::write_bib(c(
184184
[Valgrind]: http://valgrind.org/
185185
[Xcode]: https://developer.apple.com/xcode/
186186

187-
[devools]: https://devtools.r-lib.org/reference/check.html
187+
[devtools]: https://devtools.r-lib.org/reference/check.html
188188
[BiocCheck]: https://www.bioconductor.org/packages/BiocCheck/
189189
[R-Universe]: https://r-universe.dev/search

unit-tests.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ Writing unit tests is easy, though your Bioconductor package must be
215215
set up properly so that `R CMD check MyPackage` finds and run your
216216
tests. We take some pains to describe exactly how things should be
217217
set up, and what is going on behind the scenes. (See the [next
218-
section](#r-unit-during-develoment) for the simple technique to use when you
218+
section](#r-unit-during-development) for the simple technique to use when you
219219
want to test only a small part of your code).
220220

221221
The standard command `R CMD check MyPackage` sources and runs all R
@@ -251,7 +251,7 @@ There are two steps:
251251
`MyPackage/inst/unitTests/test_homeBrewArithmetic.R`
252252

253253

254-
### Using Tests During Development {#r-unit-during-develoment}
254+
### Using Tests During Development {#r-unit-during-development}
255255

256256
R CMD check MyPackage
257257

0 commit comments

Comments
 (0)