Skip to content

Latest commit

 

History

History
397 lines (358 loc) · 18.6 KB

File metadata and controls

397 lines (358 loc) · 18.6 KB

Changelog

0.14.2 (24-11-2025)

  • remove direct link dependencies to allow PyPI upload

0.14.1 (21-11-2025)

  • pin statsmodels to >= 0.14.5

0.14.0 (21-11-2025)

  • fix dimension reduction and neighbor graph overwritten by batch correction (#343)
  • remove deprecated define_pc (replaced by propose_pcs)
  • implemented dim_red
  • fix docker image build (#400)
  • connectionPlot: fix legend title issues (#369) and add parameters to edit the ranges displayed in the legends
  • hairball plot: add colormap parameter
  • cyclone plot: add restrict_to parameter (#314), fix color_max plot/colorbar mismatch (#373)
  • fix sctoolbox.plotting.qc_filter.quality_violin warning (#347)
  • fix sctoolbox.plotting.marker_genes.rank_genes_plot, "n_genes" and "var_names" are mutually exclusive (#315)
  • sctoolbox.tools.download_data: s3_downloader, download_data add option to display progress bar
  • add functions to download exemplary RNA and ATAC datasets (#376)
  • implemented sctoolbox.utils.adata.tidy_layers
  • prepare_atac_anndata: remove "path_h5ad" parameter (#335)
  • fix pl.marker_genes.rank_genes_plot, "n_genes" and "var_names" are mutually exclusive (#315)
  • fix tools.marker_genes.get_rank_genes_tables may overwrite sheets (#332)
  • automate PyPi release
  • implemented sctoolbox.utils.adata.tidy_layers (#363)
  • fix error making assembly notebook mandatory when generating report (#383)
  • replace "/" in AnnData before saving to avoid errors (#388)
  • CI/CD split notebook job into ATAC and RNA
  • sctoolbox.utils.bioutils._bed_is_sorted and _read_bedfile account for comment lines.
  • migrate to numpy 2
  • Fix error in bam_adata_ov if some reads do not contain the tag
  • add advanced tutorial notebooks (!448)
  • Add function from_R (#395)
  • update analysis reports (#225, #392)

Changes to notebooks

  • temporarily remove the velocity notebook from testing (#397)
  • update proportion_analysis notebook to be compatible with scanpro 0.4.0
  • move gene annotation (clustering -> QC; #357)
  • move HFV (QC -> normalization; #355)
  • ATAC & RNA assembly: add section to adjust layers (#363)
  • Allow multiple .rds/r.obj files to be read and merged into one adata (#395)
  • renamed 0A2_ligand_receptor_differences.ipynb to 0A2_ligand_receptor_hub_genes.ipynb

0.13.5 (20-08-2025)

  • fix pydeseq2 bug

0.13.4 (19-08-2025)

  • implemented global thread settings
  • fixed spelling mistake in title of predict cell cycle plot (#382)

0.13.3 (15-08-25)

  • from_single_mtx: auto-adjust if the var/ obs file is one line of from the expected mtx
  • add rasterization to reduce resource demand for big figures (plot_embedding, feature_per_group, search_umap-/ search_tnse_parameters, anndata_overview, pairwise_scatter)

0.13.2 (14-08-25)

  • set bbknn(computation="cKDTree") and scanorama(approx=False) to fix issue with annoy package and processor architecture

0.13.1 (13-08-25)

  • scrublet: use forkserver to start separte processes to enable multiprocessing (#380)
  • enable AnnData write compression (this was default prior to AnnData version 0.6.16)

0.13.0 (08-08-25)

  • predict_cell_cycle: implemented "gene_column" parameter
  • restrict the maximum size of a figure (2^16 pixle)
  • from_h5ad: expose concadata "label" parameter
  • Add delete_obs and delete_var parameters to prepare_for_cellxgene() (#287)
  • Add ability to use a peaks BED file to assemble var of ATAC-data (#346)
  • set scanpy>=1.11 to fix run_rank_genes error (#331)
  • GSEA: Revise gsea analysis: Bugfixes, save results into adata, rework plots (#345)
  • Add column exists check to bioutils.pseudobulk_table (#356)
  • Fix main title in receptor-ligand network plot (#358)
  • load_h5ad(): warn if adata.raw is found. (#352)
  • receptor-ligand: nan zscore to 0 (#302)
  • adjust to altered scanpy.normalize_total behavior (#370)
  • Add function to download tutorial data
  • plot_pca_variance: add selected variance line; allow log-scale
  • add global dpi setting
  • implemented suppress_logging, get_version_report, plot_table, update_yml, generate_report
  • Allow differential R-L plots to be asved as PDF
  • receptor-ligand: adjust minimum line width in connectionPlot
  • Added new notebook testdata and references. (partly #338)
  • Improved flexibility in adata creation from mtx. (#365)
  • lsi: fixed bug scaling the total variance explained to 100%

Changes to notebooks

  • velocity: Changed scvelo.read() to scanpy.read() in the velocity notebook due to deprecation (#344)
  • General: prepare_for_cellxgene: Set mampok version to 3.0.6
  • General: prepare_for_cellxgene: Add metadata parameter for mamplan correlation
  • General: prepare_for_cellxgene: Add delete column option for .obs and .var
  • RNA 02 QC: fixed bug causing initial var thresholds to be ignored
  • General: pseudotime_analysis: color dendrogram for clustering instead of segment
  • add layer option to notebooks that utilize the matrix (#342)
  • pptreport integration:
    • 01-RNA
    • 02-RNA
    • 03-RNA
    • 04-RNA
    • 0A1-RNA receptor-ligand
    • 0A2-RNA receptor-ligand differences
    • 0B-RNA velocity notebook
    • general group_markers
    • general pseudotime
    • general proportion
    • general GSEA
    • general annotation
    • 01-ATAC
    • 02-ATAC
    • 03-ATAC
    • 04-ATAC
  • RNA: implemented report notebook
  • General: annotation: add min_hits parameter
  • RNA/ ATAC 03: allow to choose the number of computed PCs
  • RNA/ ATAC 01: allow to choose batch name
  • General: Move settings to config file
  • velocity: Add missing save/embedding options
  • atac_analysis: assembling: Changed to new testdata.
  • ATAC: Implemented TOBIAS footprinting notebook
  • General: Pseudotime: Remove threads parameter from dendrogram function

0.12.0 (19-12-24)

  • add contrasts parameter to tools.marker_genes.run_deseq2
  • tools.marker_genes.pairwise_rank_genes check minimum amount of groups
  • cyclone fix shown top receptor/ligand genes
  • hairball add node_size & node_label_size

Changes to notebooks

  • General: group_marker: set n_genes as top_n for get_rank_genes_tables
  • ATAC 01 assembly: fix error when selecting the path_mtx (3rd) option (#326)
  • General: prepare_for_cellxgene: set required mampok version to 3.0.5

0.11.0 (08-11-24)

  • fix pl.embedding.plot_pca_variance() does not select all PCs using thr 100% (#309)
  • feature_per_group remove empty axis (#312)
  • fix get_rank_genes_tables return less than n_genes for filtered ranking
  • fix _search_dim_red_parameters "ValueError: 'left' is not a valid value for loc"
  • fix gseapy, louvain install outside of the docker image (#310)
  • implemented plotting.embedding.agg_feature_embedding
  • cleanup installation/ dependencies
  • CI: Revert to installing mampok from main
  • implement bgcolor cell-selection
  • update readme
  • add a bar plot to predict_cell_cycle (#301)

Changes to notebooks

  • add agg_feature_embedding to the group_marker notebook
  • fix RNA:02 zebrafish gender suggestion (#311)
  • revise 03_normalization_batch_correction notebook
  • prepare_for_cellxgene: Add auth parameter
  • use the bgcolor cell-selection in all notebooks

0.10.1 (17-09-24)

Changes to notebooks

  • rna/qc: add use_native parameter
  • annotation: fix marker repo clone cell

0.10.0 (10-09-24)

  • deseq2 (R) -> pydeseq2 (python)
  • add MAD filtering as alternative to gaussian-mixture model (#261)
  • enhance gene labelling (#38)
  • replace deprecated ratelimiter with throttle (#288)
  • Rename enrichr_marker_genes to gene_set_enrichment and add prerank as possible method.
  • Added gsea_network plot function.
  • add the markerRepo to our environment
  • Add validation of Seurat objects before converting to anndata (#293)
  • add UpSet plot for threshold comparison (#294)
  • native scrublet bugfix (#297)
  • fix planet_plot import
  • reduce warnings (#299)
  • fixed env issue

Changes to notebooks

  • expand marker_genes notebook for atac & move to general_notebooks
  • add option to choose filter method in rna/qc notebook
  • add alternative to interactive thresholds (#38)
  • use sctoolbox.plotting.embedding.plot_embedding (#279)
  • General: GSEA: Implemented gsea_network plot
  • General: GSEA: Added option to run prerank(gsea) method instead of enrichr
  • RNA: 05_receptor-ligand: Split input field into its corresponding sections
  • ATAC: 04_clustering: Docu revision of the ATAC Clustering notebook (#300)
  • RNA: 04_clustering: Docu revision of the RNA Clustering notebook (#300)
  • General: annotation: Revise annotation notebook (#269)
  • RNA: 02_QC: Docu revision of the RNA QC notebook (#296)
  • ATAC: 01_assembling_anndata: Move ATAC metric to notebook 2
  • RNA: 03_normalization_batch_correction revise docu and description (#298)

0.9.0 (02-08-24)

  • Added denoising function using scAR to QC notebook
  • added kwargs and check for quant folder in assemblers.from_quant (#280)
  • GSEA: Fix library gene-set overlap by converting all gene names to uppercase
  • pl.gsea.term_dotplot: Fix example; Fix index==None bug
  • added additional qc metrices for ATAC-seq to the first notebook (#256)
  • Pin ipywidget version to > 8.0.0 to fix interactive labels (qc notebooks)
  • revised prepare_atac_anndata (#267)
  • solved scanpy, matplotlib, pandas.. version conflict by temporarily removing scanpro (#257)
  • added planet_plot for high dimensional anndata plotting (#221)
  • implemented concadata, from_h5ad to load and combine from multiple .h5ad files (#224)
  • ligand-receptor: connectionPlot new parameters (#255)
  • pca-correlation: replace 'columns' with 'ignore' parameter, allowing to ignore numeric columns for pca correlation. (#228)
  • restructured atac notebook 3 (normalization and batch correction) (#278)
  • Fix minor docstring/example issues.
  • added labels for the tsse aggregation plot (#271)
  • Fix Notebook pipeline unable to fetch some archives (#284)
  • refactored CICD unit testing by the test_cleanup merge (#215)
  • label_genes now accepts custom genelists (#38)
  • Add inplace parameter to tfidf function (#277)
  • Update plot_group_embeddings() to also take numerical values, e.g. density
  • expand marker_genes notebook for atac, move to general_notebooks, change deseq2(R) to pydeseq2(python)

Changes to notebooks

  • improvments in description and structure of atac and general notebooks (#144)
  • added header parameter to option 2 in notebook 01_assembling_anndata (#280)
  • added notebook versioning (#115)
  • added load from multiple h5ad files to assembly notebooks (#224)
  • restructured atac notebook 3 (normalization and batch correction) (#278)
  • RNA: Notebook 4: Added density plotting for categorical qc columns.
  • RNA: Notebook 4: Replaced sc.pl.embedding from scanpy with pl.embedding.plot_embedding from sctoolbox
  • Cleanup internal notebook structure

0.8.0 (14-06-24)

  • from_mtx: support more folder structures and variable file now optional (#234, #240)
  • ligand-receptor: download_db added support for LIANA resources
  • revised tsse scoring and fixed matplotlib version conflict (#257)
  • add cyclone (pycirclize based plot) as hairball alternative (#223)
  • remove legacy import structure
  • implement lazy module loading
  • wrapped up native scrublet (#242, #150)
  • prepare_for_cellxgene: Account for duplciate var indices
  • added number of features to ATAC nb 3 and added combat as an available batch correct algorithm (#245)
  • removed cleanup temp for the selfservice container (#258)

Changes to notebooks

  • rna/ atac more subset PC description
  • rna/ atac clustering renamed "recluster" -> "revise cluster"
  • Add GSEA notebook (#172)
  • rna/atac assembly notebook update from_mtx (#234, #240)

0.7.0 (23-04-24)

  • Added code examples for tools and utils (#140)
    • recluster
    • group_heatmap
    • plot_venn
    • in_range
  • Fix notebooks in readthedocs documentation (#220)
  • Removed custom_marker_annotation script
  • Disintegrated FLD scoring and added PEAKQC to setup.py (#233)
  • fixed PCA-var plot not fitting into anndata_overview (#232)

Changes to notebooks

  • Overhaul RNA & ATAC notebooks structure (includes #207)
  • Revise RNA notebook 4 recluster section (#201)

0.6.1 (28-03-24)

  • Fix release pages by renaming the release-pages: job to pages:
  • refactor move clean-orphaned-tags to new stage .post (#229)

0.6 (27-03-24)

  • Fix unable to determine R_HOME error (#190)
  • implemented propose_pcs to automatically select PCA components (#187)
  • add correlation barplot to plot_pca_variance
  • created correlation_matrix method by restructuring plot_pca_correlation
  • Fix beartype issue with Lists and Iterables containing Literals (#227)
  • CICD overhaul (#191)
  • fixed notebook version in the env to 6.5.2 (#199, partly #44)

Changes to notebooks

  • Move proportion_analysis notebooks to general notebooks (#195 and #214)
  • replace scanpy pseudotime with scFates in pseudotime_analysis notebook
  • prepare_for_cellxgene: Adapt to new mampok verison 2.0.9
  • prepare_for_cellxgene: Allows the user to set an analyst manually (#213)
  • rna 03_batch revision (#209, #202, #200, #152)
  • 05_marker_genes: Complete Overhaul (#181)

0.5 (04-03-24)

  • add receptor_genes & ligand_genes parameters to connectionPlot and decreased runtime
  • readme update(#188)
  • Fix error when writing adata converted from an R object (#205, #180)
  • Marker Repo integration (#162)
  • Set scvelo version to >=0.3.1 (#193)
  • Added fa2 as dependency for pseudotime analysis
  • anndata_overview: fix issue where colorbars for continuous data was not shown
  • added ability to use highly variable features using the lsi() function (#165)
  • removed deprecated group_heatmap, umap_pub (replaced by gene_expression_heatmap, plot_embedding)
  • add doku page
  • start change log

Changes to notebooks

  • rna assembly: refactor
  • prepare_for_cellxgene: Added BN_public as possible deployment cluster (#192)
  • 14_velocity_analysis: Remove duplicate parameter (#194)
  • pseudotime_analysis: Save generated plots (#211)
  • rna 03_batch: added qc metrics to overview plot

0.4 (31-1-24)

  • Fix get_rank_genes_tables for groups without marker genes (#179)
  • Bugfixes for CI jobs
  • Fix check_changes pipeline
  • Fix typos (#173 & #174)
  • Include kwargs in utils.bioutils._overlap_two_bedfiles(#177)
  • Implemented _add_path() to automatically add python path to environment
  • added tests for _add_path() and _overlap_two_bedfiles() (#177)
  • constraint ipywidgets version to 7.7.5 to fix the quality_violinplot() (#151)(#143)
  • Add temp_dir to calc_overlap_fc.py (#167) and revised related functions
  • more testing (mainly sctoolbox.tools) (#166)
  • gerneral text revisions

Changes to notebooks

  • Add pseudotime & velocity analysis notebooks (#164)
  • Update receptor-ligand notebook (#176)
  • Refactored annotate_genes() from ATAC-notebook 05 to 04 and removed 05 (#175)

0.3 (30-11-2023)

  • Add parameter type hinting including runtime type checking (#46)
  • Fixed prepare_for_cellxgene color issue (#145, #146)
  • Add CI/CD container build pipeline for testing (#135)
  • Fixed example for gene_expression_heatmap and smaller bugfixes related to marker genes (#124)
  • Removed pl.group_heatmap as it is fully covered by pl.gene_expression_heatmap
  • Removed 'sinto' as dependency and added code in 'create_fragment_file' to create fragment file internally (solves #147)
  • The function 'create_fragment_file' was moved to bam tools.
  • Added "n_genes" parameter to tools.marker_genes.get_rank_genes_tables, and set the default to 200 (#153)
  • Fixed CI/CD build job rules. Only trigger build job when files changed or triggered manually
  • Add parameter to plot_pca_correlation to plot correlation with UMAP components (#157)
  • Handle NaN values for plot_pca_correlation (#156)
  • implemented prepare_for_cellxgene
  • Added pl.embedding.plot_embedding() function to plot embeddings with different styles, e.g. hexbin and density (#149)
  • Modified pl.embedding.plot_embedding() to plot different embedding dimensions
  • Deprecated pl.umap_pub as this is now covered by pl.plot_embedding
  • changed typing to beartype.typing
  • Added GenomeTracks plotting
  • Fix batch evaluation for small datasets (#148)
  • Added **kwargs to functions which are wrappers for other functions
  • added RAGI cluster validation to clustering.py (!201)
  • started disintegrating fld scoring (!201)
  • reorganised ATAC-notebooks (!201)

Changes to notebooks

  • Added prepare for cellxgene notebook (#139)
  • Added plot of highly expressed genes to RNA notebook 03 (#43)
  • Changed structure of notebooks in directory; added "notebooks" subdirectories for RNA and ATAC

0.2 (30-08-2023)

  • fix error in prepare_for_cellxgene caused by .uns[_color] not matching .obs column. (#176)
  • implemented prepare_for_cellxgene (#147)
  • fixed raw value copy issue in rna/02-batch notebook
  • Added parameters for the TOBIAS flags in the config file to write_TOBIAS_config()
  • Added logging verbose and decorator to ATAC related functions
  • Fix "shell not found" error for CI pipeline (#129)
  • Pinned scikit-learn to version <=1.2.2 (#128)
  • Added script for gene correlation and comparison between two conditions
  • Added check for marker gene lists (#103)
  • Keep notebook metadata on push to prevent deleting kernel information
  • Added sctoolbox as default kernel to RNA & ATAC notebooks
  • Added check of column validity to tools.marker_genes.run_DESeq2() (#134)
  • Increase test coverage for plotting functions (#126)
  • Apply fixes to bugs found by increasing the test coverage.
  • Added type hinting to functions.
  • Revised doc-strings.
  • run_rank_genes() auto converts groupby column to type 'category' (#137)
  • Fix parameter for gene/cell filtering (#136)
  • Add Check to _filter_object() if column contains only boolean (#110)
  • Add support of matrx and numpy.ndarray type of adata.X for predict_sex (#111)
  • Add method to get pd.DataFrame columns with list of regex (#90)
  • Added 'pairwise_scatter' method for plotting QC metrics (#54)
  • Add ATAC quality metrics TSSe (ENCODE), FRiP
  • Revised FLD density plotting
  • Adjusted style of default values in docs (#33)
  • Added 'plot_pca_correlation' for plotting PCA correlation with obs/var columns (#118)
  • Removed outdated normalization methods.
  • Changed all line endings to LF (#138)
  • Disabled threads parameter for tSNE (#130)
  • Added 'plot_starsolo_quality' and 'plot_starsolo_UMI' to plotting module (#78)
  • Fixed issues with clustered dotplot with new code (#122)

Changes to RNA notebooks

  • Added display of 3D UMAP html in notebook 04 (#119)

Changes to ATAC notebooks

  • Fixed assembling atac notebook 01
  • Fixed get_atac_thresholds_wrapper and renamed it to get_thresholds_wrapper
  • Added custome cwt implementation
  • Added additional parameters to add_insertsize_metrics
  • Revised nucleosomal score scoring

0.1.1 (24-05-2023)

  • Fixed import issue
  • Make version accessible
  • Added check for CHANGES.rst in gitlab-ci
  • Pinned numba==0.57.0rc1 due to import error (#117)
  • Fixed bug in tools.norm_correct.atac_norm
  • Added check for sctoolbox/_version.py file in gitlab-ci

0.1 (22-05-2023)

  • First version