Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion build-check-bioccheck.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ version.


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


As Bioconductor moves towards integration with
Expand Down
6 changes: 3 additions & 3 deletions docs/package-review-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Example: Seurat and data.frames are not Bioconductor classes. Packages certainly
may keep this interoperability and generality but they should also be able to work
_directly_ with the equivalent Bioconductor class in this case likely a SummarizedExperiment or
SingleCellExperiment (maybe with a designed wrapper function, e.g). The majority
of documentation and runnable code should emphasize/demonstarte the interaction
of documentation and runnable code should emphasize/demonstrate the interaction
with Bioconductor objects (it may be in addition to the others capabilities).


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

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

## The NEWS file

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

Expand Down
2 changes: 1 addition & 1 deletion index.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,6 @@ knitr::write_bib(c(
[Valgrind]: http://valgrind.org/
[Xcode]: https://developer.apple.com/xcode/

[devools]: https://devtools.r-lib.org/reference/check.html
[devtools]: https://devtools.r-lib.org/reference/check.html
[BiocCheck]: https://www.bioconductor.org/packages/BiocCheck/
[R-Universe]: https://r-universe.dev/search
4 changes: 2 additions & 2 deletions unit-tests.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ Writing unit tests is easy, though your Bioconductor package must be
set up properly so that `R CMD check MyPackage` finds and run your
tests. We take some pains to describe exactly how things should be
set up, and what is going on behind the scenes. (See the [next
section](#r-unit-during-develoment) for the simple technique to use when you
section](#r-unit-during-development) for the simple technique to use when you
want to test only a small part of your code).

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


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

R CMD check MyPackage

Expand Down
Loading