Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release/5.0.2 #205

Merged
merged 57 commits into from
May 8, 2024
Merged

Release/5.0.2 #205

merged 57 commits into from
May 8, 2024

Conversation

dcollins15
Copy link
Collaborator

@dcollins15 dcollins15 commented May 7, 2024

Release SeuratObject v5.0.2

  • Bump version
  • Update CRAN comments
  • Update changelog
  • Win-builder
  • Mac-builder
  • Submit to CRAN
  • Resolve issues with submission
  • Re-submit to CRAN

Additional Changes:

  • Added an entry for the ... param in the docstring for the Radius generic - this seems to be required for CRAN checks to pass, at least on my local machine

mojaveazure and others added 30 commits December 20, 2023 14:35
- Transfer maintainer to Rahul and mark myself as an author
- Update emails to reflect non-maintainer
- Update package URLs to new GH repo/site
- Add David as an author
Update maintainer and package URLs
This PR adjusts `Matrix`-related imports and provides some (re)exports
for Seurat, namely:
1) re-export `Matrix::t()` so that Seurat can import `t()` from
   SeuratObject instead of `Matrix`
2) define `t.spam()` (which dispatches to `spam::t()`) since dispatch
   for spam matrices doesn't natively work with `Matrix::t()`
3) define new `EmptyMatrix()` function for creating empty matrices;
   should allow Seurat to remove its import of `dgCMatrix`

The motiviation is to provide a single point of management
of `Matrix` for Seurat and SeuratObject as we've had issues in the past
where `Matrix` updates negatively impact both packages
Adjust imports and reexports from `Matrix`
Adjust reexport of `%||%` to be a proper reexport instead of a redefine.
This should hopefully silence warnings in scCustomize

resolves #177
Update changelog
This PR updates some infrastructure around keys:
- Class warnings around keys
- Simplify and stabilize logic around handling key warnings
- Fix incorrect documentation
- Add single place to refer to meta data keys

This PR also ups the minimum version of R to 4.1.0 to make use of lambdas
This PR updates some infrastructure around keys:
- Class warnings around keys
- Simplify and stabilize logic around handling key warnings
- Fix incorrect documentation
- Add single place to refer to meta data keys

This PR also ups the minimum version of R to 4.1.0 to make use of lambdas
Bump develop version
Bump develop version
Fixes error in UpdateSeuratObject due to missing global slot.
Gesmira and others added 21 commits April 15, 2024 12:07
Co-authored-by: Paul Hoffman <[email protected]>
Subsetting feature-level metadata fix
Use the package version of SeuratObject instead of Seurat in `UpdateSeuratObject()`; this allows running `UpdateSeuratObject()` without requiring Seurat to be installed
Use `packageVersion("SeuratObject")` in `UpdateSeuratObject()`
This is meant to help diagnose issues when assay doesn't have desired layer. 
For example see satijalab/seurat#8658 and discussion in satijalab/seurat#8659.

The warning message might not be the prettiest, but I didn't want to go through `Layer.Seurat` method to get the assay name.
Bump develop version
Add warning if layer is absent from assay
@dcollins15
Copy link
Collaborator Author

dcollins15 commented May 7, 2024

CRAN rejected our initial submission with the following message:

Package has help file(s) containing install/render-stage \Sexpr{}
expressions but no prebuilt PDF manual.

Any idea what's going on here @mojaveazure? Maybe related to r-lib/lifecycle#39?

@mojaveazure
Copy link
Member

The PDF is bundled in /build, not /inst; my guess is there's an issue with LaTeX on your system. Check the logs from R CMD build to see why the PDF failed to build. In the mean time, here's a tarball built from release/5.0.2 with the manual in it (sorry for the mix of \ and /; I'm on Windows so I get to deal with all sorts of Windows vs *nix oddities)

 PS C:\Users\Paul Hoffman> tar -tvzf .\SeuratObject_5.0.2.tar.gz SeuratObject/build/*.pdf
-rw-rw-rw-  0 0      0      416556 May 07 11:10 SeuratObject/build/SeuratObject.pdf

SeuratObject_5.0.2.tar.gz

cran-comments.md Outdated Show resolved Hide resolved
@mojaveazure
Copy link
Member

For reference, R CMD check output

PDF check:

* checking PDF version of manual ... OK

Full log:

PS C:\Users\Paul Hoffman> R.exe CMD check --as-cran .\SeuratObject_5.0.2.tar.gz
* using log directory 'C:/Users/Paul Hoffman/SeuratObject.Rcheck'
* using R version 4.2.2 (2022-10-31 ucrt)
* using platform: x86_64-w64-mingw32 (64-bit)
* using session charset: UTF-8
* using option '--as-cran'
* checking for file 'SeuratObject/DESCRIPTION' ... OK
* checking extension type ... Package
* this is package 'SeuratObject' version '5.0.2'
* package encoding: UTF-8
* checking CRAN incoming feasibility ... NOTE
Maintainer: 'Rahul Satija <[email protected]>'

New maintainer:
  Rahul Satija <seurat@nygenome.org>
Old maintainer(s):
  Paul Hoffman <seurat@nygenome.org>

Suggests or Enhances not in mainstream repositories:
  BPCells
Availability using Additional_repositories specification:
  BPCells   yes   https://bnprks.r-universe.dev
* checking package namespace information ... OK
* checking package dependencies ... OK
* checking if this is a source package ... OK
* checking if there is a namespace ... OK
* checking for executable files ... OK
* checking for hidden files and directories ... OK
* checking for portable file names ... OK
* checking whether package 'SeuratObject' can be installed ... [54s] WARNING
Found the following significant warnings:
  Warning: package 'sp' was built under R version 4.2.3
See 'C:/Users/Paul Hoffman/SeuratObject.Rcheck/00install.out' for details.
* checking installed package size ... OK
* checking package directory ... OK
* checking for future file timestamps ... OK
* checking DESCRIPTION meta-information ... OK
* checking top-level files ... OK
* checking for left-over files ... OK
* checking index information ... OK
* checking package subdirectories ... OK
* checking R files for non-ASCII characters ... OK
* checking R files for syntax errors ... OK
* checking whether the package can be loaded ... OK
* checking whether the package can be loaded with stated dependencies ... OK
* checking whether the package can be unloaded cleanly ... OK
* checking whether the namespace can be loaded with stated dependencies ... OK
* checking whether the namespace can be unloaded cleanly ... OK
* checking loading without being on the library search path ... OK
* checking use of S3 registration ... OK
* checking dependencies in R code ... OK
* checking S3 generic/method consistency ... OK
* checking replacement functions ... OK
* checking foreign function calls ... OK
* checking R code for possible problems ... [27s] OK
* checking Rd files ... OK
* checking Rd metadata ... OK
* checking Rd line widths ... OK
* checking Rd cross-references ... OK
* checking for missing documentation entries ... OK
* checking for code/documentation mismatches ... OK
* checking Rd \usage sections ... OK
* checking Rd contents ... OK
* checking for unstated dependencies in examples ... OK
* checking contents of 'data' directory ... OK
* checking data for non-ASCII characters ... OK
* checking LazyData ... OK
* checking data for ASCII and uncompressed saves ... OK
* checking line endings in C/C++/Fortran sources/headers ... OK
* checking pragmas in C/C++ headers and code ... OK
* checking compilation flags used ... OK
* checking compiled code ... OK
* checking examples ... [39s] NOTE
Examples with CPU (user + system) or elapsed time > 5s
              user system elapsed
SaveSeuratRds 2.51   0.14       6
* checking PDF version of manual ... OK
* checking for non-standard things in the check directory ... OK
* checking for detritus in the temp directory ... OK
* DONE

Status: 1 WARNING, 2 NOTEs
See
  'C:/Users/Paul Hoffman/SeuratObject.Rcheck/00check.log'
for details.

Ignore the warning, that's just due to Windows binary builds

@dcollins15
Copy link
Collaborator Author

dcollins15 commented May 8, 2024

v5.0.2 is on its way to CRAN! See https://cran.r-project.org/web/packages/SeuratObject/index.html

@dcollins15 dcollins15 merged commit 58bf437 into master May 8, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants