Skip to content

Commit

Permalink
CRAN release of 1.1.1. (#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
cb4ds authored May 10, 2022
1 parent 643c984 commit e212c72
Show file tree
Hide file tree
Showing 31 changed files with 161 additions and 79 deletions.
45 changes: 45 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,50 @@ jobs:
name: Check coverage
command: Rscript -e 'library(covr); codecov(quiet = FALSE)'

Build-for-r4_1_3:
docker:
- image: rocker/verse:4.1.3
resource_class: medium

steps:
- checkout
- run:
name: Review checkout
command: ls -la

- run:
name: Install Linux dependencies
command: |
sudo apt-get update -y
sudo apt-get install -yq texlive-fonts-recommended
sudo apt-get install -yq texlive-fonts-extra
- run:
name: Install R dependencies
command: |
R -e 'install.packages("BiocManager")'
R -e 'BiocManager::install(c("GenomicRanges", "edgeR", "biomaRt"))'
R -e 'install.packages("covr")'
R -e 'install.packages("conflicted")'
- run:
name: Session information and installed package versions
command: |
Rscript -e 'sessionInfo()'
Rscript -e 'installed.packages()[, c("Package", "Version")]'
Rscript -e 'rmarkdown::pandoc_version()'
- run:
name: Build package
command: R CMD build .
- run:
name: Check package
command: |
# Install suggested packages
R -e 'install.packages("png")'
# Perform package check
R CMD check *tar.gz
- run:
name: Check coverage
command: Rscript -e 'library(covr); codecov(quiet = FALSE)'

Build-for-rLATEST:
docker:
- image: rocker/verse:latest
Expand Down Expand Up @@ -97,4 +141,5 @@ workflows:
Prepare-All-R-Editions:
jobs:
- Build-for-r4_0_5
- Build-for-r4_1_3
- Build-for-rLATEST
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: DGEobj
Type: Package
Title: Differential Gene Expression (DGE) Analysis Results Data Object
Version: 1.1.0
Version: 1.1.1
Description:
Provides a flexible container to manage and annotate Differential Gene
Expression (DGE) analysis results (Smythe et. al (2015) <doi:10.1093/nar/gkv007>).
Expand Down
1 change: 1 addition & 0 deletions DGEobj.Rproj
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,5 @@ StripTrailingWhitespace: Yes
BuildType: Package
PackageUseDevtools: Yes
PackageInstallArgs: --no-multiarch --with-keep.source
PackageCheckArgs: --as-cran
PackageRoxygenize: rd,collate,namespace,vignette
5 changes: 4 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,14 @@

---

### v1.1.1
* Updated tests and examples so that when suggested packages are unavailable the examples and/or tests dependent on them are not run

### v1.1
* made GenomicRanges package optional - used only for exon/gene levels
* added "protein" level data, reviewed/updated isoform data for proper handling
* added imputationMatrix as a type of metadata
* reworked reset to resolve issues and remove unneded code
* reworked reset to resolve issues and remove unneeded code
* updated tests and documentation

### v1.0.3
Expand Down
3 changes: 2 additions & 1 deletion R/addItem.R
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ addItem <- function(dgeObj,
#' @return A DGEobj
#'
#' @examples
#'
#' \dontrun{
#' # Add normalize counts (DGEList) and log2CPM as additional "assay" items in the DGEobj
#' dgeObj <- readRDS(system.file("exampleObj.RDS", package = "DGEobj"))
#' dgeList <- edgeR::calcNormFactors(edgeR::DGEList(dgeObj$counts), method="TMM")
Expand All @@ -179,6 +179,7 @@ addItem <- function(dgeObj,
#' parents = list("counts", "newDgelist")
#' )
#' inventory(dgeObj)
#' }
#'
#' @importFrom assertthat assert_that
#'
Expand Down
2 changes: 2 additions & 0 deletions R/attributes.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,12 @@
#' "dimnames", "rownames", "colnames", "listData", "objDef")
#'
#' @examples
#' \dontrun{
#' # example DGEobj
#' exObj <- readRDS(system.file("exampleObj.RDS", package = "DGEobj"))
#'
#' showAttributes(exObj)
#'}
#'
#' @export
showAttributes <- function(dgeObj, skipList = c("dim", "dimnames", "rownames", "colnames", "listData", "objDef")) {
Expand Down
2 changes: 2 additions & 0 deletions R/reset.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
#' @return A DGEobj
#'
#' @examples
#' \dontrun{
#' #example object
#' exObj <- readRDS(system.file("exampleObj.RDS", package = "DGEobj"))
#'
Expand All @@ -19,6 +20,7 @@
#'
#' exObj <- resetDGEobj(exObj)
#' dim(exObj)
#'}
#'
#' @importFrom assertthat assert_that
#'
Expand Down
2 changes: 2 additions & 0 deletions R/subset.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@
#' @return A DGEobj
#'
#' @examples
#' \dontrun{
#' # example DGEobj
#' exObj <- readRDS(system.file("exampleObj.RDS", package = "DGEobj"))
#'
#' exObj <- subset(exObj, 1:10, 5:50)
#'}
#'
#' @importFrom assertthat assert_that
#' @importFrom stringr str_c
Expand Down
4 changes: 4 additions & 0 deletions R/utils.R
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,12 @@ dimnames.DGEobj <- function(x){
#' @return NULL
#'
#' @examples
#' \dontrun{
#' # example DGEobj
#' exObj <- readRDS(system.file("exampleObj.RDS", package = "DGEobj"))
#'
#' print(exObj)
#'}
#'
#' @export
print.DGEobj <- function(x, ..., verbose = FALSE) {
Expand All @@ -65,10 +67,12 @@ print.DGEobj <- function(x, ..., verbose = FALSE) {
#' @return A data.frame summarizing the data contained in the DGEobj
#'
#' @examples
#' \dontrun{
#' # example DGEobj
#' exObj <- readRDS(system.file("exampleObj.RDS", package = "DGEobj"))
#'
#' inventory(exObj)
#' }
#'
#' @export
inventory <- function(dgeObj, verbose = FALSE) {
Expand Down
15 changes: 8 additions & 7 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
## Comments from Maintainer

* made GenomicRanges package optional - used only for exon/gene levels
* added "protein" level data, reviewed/updated isoform data for proper handling
* added imputationMatrix as a type of metadata
* reworked reset to resolve issues and remove unneeded code
* updated tests and documentation
* Resolved CRAN check errors
* Skipping examples dependent on suggested packages
* Updated tests so that they do not fail if suggested packages are not available

---

Expand All @@ -20,6 +18,7 @@ CircleCI

* R 4.0.5
* R 4.1.3
* rocker/verse:latest

WinBuilder

Expand All @@ -28,7 +27,8 @@ WinBuilder

RHub

* devtools::check_rhub(interactive = F)
* devtools::check_rhub(interactive = F,
env_vars = c("_R_CHECK_DEPENDS_ONLY_" = "true"))

---

Expand All @@ -54,7 +54,8 @@ revdepcheck::cran_revdeps('DGEobj', bioc = T)
```

```
revdepcheck:: revdep_report_cran()
revdepcheck::revdep_report_cran()
## revdepcheck results
We checked 1 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
Expand Down
3 changes: 2 additions & 1 deletion man/addItems.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions man/inventory.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions man/print.DGEobj.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions man/resetDGEobj.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions man/showAttributes.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions man/subset.DGEobj.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion misc/test_object_creation/create_objects.R
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@ dge_creation_workflow <- function(counts, gene.data, design, qcdata, contrast_li
result <- result[result$geneData$gene_biotype == "protein_coding", ]

# Normalize
result <- runEdgeRNorm(result, includePlot = FALSE)
if (requireNamespace("edgeR", quietly = TRUE)) {
result <- runEdgeRNorm(result, includePlot = FALSE)
}

# Define Model
formula <- '~ 0 + ReplicateGroup'
Expand Down
Loading

0 comments on commit e212c72

Please sign in to comment.