Skip to content

Commit

Permalink
fixed NEWS.md so it shows up on website
Browse files Browse the repository at this point in the history
  • Loading branch information
MicTott committed Nov 20, 2024
1 parent 8fda1da commit 3d4e417
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ Package: SpotSweeper
Title: Spatially-aware quality control for spatial transcriptomics
Version: 1.3.1
Date: 2024-11-08

Authors@R: c(
person("Michael", "Totty", ,"[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "0000-0002-9292-8556")),
Expand Down Expand Up @@ -52,3 +51,4 @@ Suggests:
Config/testthat/edition: 3
VignetteBuilder: knitr
LazyData: False
News: NEWS.md
8 changes: 4 additions & 4 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# SpotSweeper Package News

## Version 1.3.1
# Version 1.3.1

### Major Changes
## Major Changes
- **Function Renaming**: The function `plotQC` has been renamed to `plotQCmetrics` to better reflect its purpose. The new function `plotQCmetrics` should be used moving forward. This change improves clarity in the package’s API by specifying that this function is designed for plotting QC metrics.


### New Features and Enhancements
## New Features and Enhancements
- **`shape` argument**: Added a `shape` argument to `findArtifacts`, allowing users to specify the neighborhood shape as either `"hexagonal"` or `"square"` for local variance calculations. This enhancement provides flexibility for different spatial arrangements in spatial transcriptomics data.

- **Updated `n_order` parameter**: Renamed the `n_rings` parameter to `n_order` in the `findArtifacts` function to better describe its purpose of specifying the N-order neighbors for local mitochondrial variance calculations.

- **Parallelization**: Added a `workers` argument for parallel processing using `BiocParallel` in both `localOutlier` and `localVariance` functions. This allows for faster computation, particularly on larger datasets.

### Deprecations
## Deprecations
- **`plotQC` Function Deprecated**: The `plotQC` function is now deprecated. While it remains available for backward compatibility, users are encouraged to transition to `plotQCmetrics`. Calling `plotQC` will display a warning, reminding users of the deprecation.

This change is backward compatible; existing code using `plotQC` will still work but will show a warning. We recommend updating your code to use `plotQCmetrics` to avoid any issues in future versions where `plotQC` may be removed.

0 comments on commit 3d4e417

Please sign in to comment.