Published June 27, 2022
| Version v0.2.2
Software
Open
zktuong/dandelion: v0.2.2
Authors/Creators
- 1. University of Cambridge
- 2. Medical University of Innsbruck
Description
What's Changed
- try and add youtube video to docs by @zktuong in https://github.com/zktuong/dandelion/pull/148
- testing_rpy2_update by @zktuong in https://github.com/zktuong/dandelion/pull/150
- Speed upgrade - Refactor generate network by @zktuong in https://github.com/zktuong/dandelion/pull/152 ## Bug fixes and Improvements
- Speed up
generate_network- pair-wise hamming distance is calculated on per clone/clonotype only if more than 1 cell is assigned to a clone/clonotype
.distanceslot is removed and is now directly stored/converted from the.graphslot.- new options:
compute_layout: bool = True. If dataset is too large,generate_layoutcan be switched toFalsein which case only thenetworkxgraph is returned. The data can still be visualised later withscirpy'splotting method (see below).layout_method: Literal['sfdp', 'mod_fr'] = 'sfdp'. New default uses the ultra-fast C++ implementedsfdp_layoutalgorithm ingraph-toolsto generate final layout.sfdpstands for Scalable Force Directed Placement.- Minor caveat is that the repulsion is not as good - when there's a lot of singleton nodes, they don't separate well unless you some how work out which of the parameters in sfdp_layout to tweak will produce an effective separate. changing
gammaalone doesn't really seem to do much. - The original layout can still be generated by specifying
layout_method = 'mod_fr'. Requires a separate installation ofgraph-toolvia conda (not managed by pip) as it has several C++ dependencies. - pytest on macos may also stall because of a different backend being called - this is solved by changing tests that calls
generate_networkto run last.
- Minor caveat is that the repulsion is not as good - when there's a lot of singleton nodes, they don't separate well unless you some how work out which of the parameters in sfdp_layout to tweak will produce an effective separate. changing
- added steps to reduce memory hogging.
min_sizewas doing the opposite previously and this is now fixed. #155
- Speed up
transfer- Found a faster way to create the connectivity matrix.
- this also now transfer a dictionary that
scirpycan use to generate the plots https://github.com/scverse/scirpy/issues/286 - Fix #153
- rename
productivetoproductive_status.
- rename
- Fix #154
- reorder the if-else statements.
- Speed up
filter_contigs- tree construction is simplified and replaced for-loops with dictionary updates.
- Speed up
initialise_metadata.Dandelionshould now initialise and read faster.- Removed an unnecessary data sanitization step when loading data.
- Now
load_datawill renameumi_counttoduplicate_count - Speed up
Query- tree construction is simplified and replaced for-loops with dictionary updates.
- didn't need to use an airr validator as that slows things down.
- data initialised by
Dandelionwill be ordered based on productive first, then followed by umi count (largest to smallest).
initialise_metadata/update_metadata/Dandelion- For-loops to initialise the object has veen vectorized, resulting in a minor speed uprade
- This results in reduction of some columns in the
.metadatawhich were probably bloated and not used.vdj_statusandvdj_status_summaryremoved and replaced withrearrangement_VDJ_statusandrearrange_VJ_statusconstant_statusandconstant_summaryremoved and replaced withconstant_VDJ_statusandconstant_VJ_status.productiveandproductive_summarycombined and replaced withproductive_status.locus_statusandlocus_status_summarycombined and replaced withlocus_status.isotype_summaryreplaced withisotype_status.
- where there was previously
unassignedor''has been changed to :str:Nonein.metadata.- Not changed to
NoneTypeas there's quite a bit of text processing internally that gets messed up if swapped. No_contigwill still be populated after transfer toAnnDatato reflect cells with no TCR/BCR info.
- Not changed to
- deprecate use of nxviz<0.7.4
- reworked code to use the updated version at https://github.com/zktuong/nxviz/tree/custom_color_mapping_circos_nodes_and_edges
- Rename and deprecate
read_h5/write_h5. Use ofread_h5ddl/write_h5ddlwill be enforced in the next update.
Full Changelog: https://github.com/zktuong/dandelion/compare/v0.2.1...v0.2.2
Files
zktuong/dandelion-v0.2.2.zip
Additional details
Related works
- Is supplement to
- https://github.com/zktuong/dandelion/tree/v0.2.2 (URL)