Added package details

[arielah]

This should be able to go on bioconductor, it has passed BiocCheck() without errors or warnings, but there were a couple notes and any recommendations for style changes or additions would be appreciated.

[lmweber]

This looks really good!

Two minor initial comments while I am installing it and running checks:

• I think scater needs to be added to Suggests: in DESCRIPTION for the vignette
• There is a typo in the Title line in DESCRIPTION (probabilistic)

[lmweber]

A few more things from the checks I just ran - devtools::check() and BiocCheck::BiocCheck() in R-devel / Bioc-devel:

• The @examples all need library(scater) (for addPerCellQC) - this currently gives an error on devtools::check():

  ❯ checking examples ... ERROR
  Running examples in ‘miQC-Ex.R’ failed
  ...
  could not find function "addPerCellQC"
  Execution halted

• It is also giving a warning:

  ❯ checking for unstated dependencies in examples ... WARNING
  '::' or ':::' import not declared from: ‘BiocParallel’

• The easiest way to fix this might be to put library(BiocParallel) at the top of the example, and remove the ::
• There is also a warning for rmarkdown not being available for the vignette - I think this can be fixed by putting rmarkdown in Suggests: in DESCRIPTION
• miQC.Rproj should be removed from the GitHub repo by adding it to .gitignore (this is currently a NOTE)
• Bioconductor recommends adding a NEWS file in inst/NEWS. This has a specific format and can be updated later when you add new versions.

Then some additional things that I would describe as more optional, but also very useful:

• One of the NOTEs also recommends adding unit tests. These can take a while to set up, but are very useful later when you make updates, so could be worth considering.
• You could also set up automated testing with GitHub Actions. Then it will run all the checks on GitHub each time you push an update, and you get a green badge to show on the readme.
• It would also be useful to add some more info on the readme, e.g. some quick information and installation details.