Package: regsyn
kwixDeveloper GuideSetup# create conda environment$mambaenvcreate-fenv.yml# update conda environment$mambaenvupdate-nkwix--fileenv.ymlInstallpipinstall-e.# install from pypipipinstallkwixnbdev# activate conda environment$condaactivatekwix# make sure the kwix package is installed in development mode$pipinstall-e.# make changes under nbs/ directory# ...# compile to have changes apply to the kwix package$nbdev_preparePublishing# publish to pypi$nbdev_pypi# publish to conda$nbdev_conda--build_args'-c conda-forge'$nbdev_conda--mambabuild--build_args'-c conda-forge -c dsm-72'UsageInstallationInstall latest from the GitHubrepository:$pipinstallgit+https://github.com/dsm-72/kwix.gitor fromconda$condainstall-cdsm-72kwixor frompypi$pipinstallkwixDocumentationDocumentation can be found hosted on GitHubrepositorypages. Additionally you can find
package manager specific guidelines oncondaandpypirespectively.Toy Inheritance@dataclassclassFoo(KWix):_:KW_ONLYa:int=1b:int=2c:int=3@dataclassclassQux(KWix):_:KW_ONLYq:str=-2u:str=-1x:int=0@dataclassclassBar(Foo):_:KW_ONLYx:int=7y:int=8z:int=9@dataclassclassBaz(Bar,Qux):_:KW_ONLYa:int=6b:int=7q:int=0@dataclassclassAuz(Bar):_:KW_ONLYSeabornSince Seaborn Clustermap passes all extra keyword-arguments to Heatmap
usingKWixcan make it
easy to know what these parameters are and easy to pass them accordingly@dataclassclassSeabornHeatmap(KWix):_:KW_ONLY# heatmap parametersvmin:Optional[float]=Nonevmax:Optional[float]=Nonecmap:Optional[str]='inferno'center:Optional[float]=Nonerobust:bool=Trueannot:Optional[bool]=Nonefmt:Optional[str]='.2g'annot_kws:Optional[dict]=Nonelinewidths:Optional[float]=0linecolor:Optional[str]='white'cbar:bool=Truecbar_kws:Optional[dict]=Nonecbar_ax:Optional['Axes']=Nonesquare:bool=Falsexticklabels:Union[bool,list,str,bool]='auto'yticklabels:Union[bool,list,str,bool]='auto'mask:Optional[Union['NPArray','DataFrame']]=Noneax:Optional['Axes']=None@dataclassclassSeabornClustermap(SeabornHeatmap,KWix):_:KW_ONLY# clustermap parameterspivot_kws:Optional[dict]=Nonemethod:'LinkageMethod'='SINGLE'metric:'PDistMetric'='CORRELATION'z_score:Optional[int]=0standard_scale:Optional[int]=Nonefigsize:Tuple[int,int]=(10,10)cbar_kws:Optional[dict]=Nonerow_cluster:bool=Truecol_cluster:bool=Truerow_linkage:Optional[dict]=Nonecol_linkage:Optional[dict]=Nonerow_colors:Optional[dict]=Nonecol_colors:Optional[dict]=Nonemask:Optional[dict]=Nonedendrogram_ratio:float=0.2colors_ratio:float=0.03cbar_pos:'CBarPos'=(0.02,0.8,0.05,0.18)tree_kws:Optional[dict]=Noneclstmap=SeabornClustermap()clstmap.curvals(){'cbar_kws': None,
 'cbar_pos': (0.02, 0.8, 0.05, 0.18),
 'col_cluster': True,
 'col_colors': None,
 'col_linkage': None,
 'colors_ratio': 0.03,
 'dendrogram_ratio': 0.2,
 'figsize': (10, 10),
 'mask': None,
 'method': 'SINGLE',
 'metric': 'CORRELATION',
 'pivot_kws': None,
 'row_cluster': True,
 'row_colors': None,
 'row_linkage': None,
 'standard_scale': None,
 'tree_kws': None,
 'z_score': 0}clstmap.inhvals(){'annot': None,
 'annot_kws': None,
 'ax': None,
 'cbar': True,
 'cbar_ax': None,
 'center': None,
 'cmap': 'inferno',
 'fmt': '.2g',
 'linecolor': 'white',
 'linewidths': 0,
 'robust': True,
 'square': False,
 'vmax': None,
 'vmin': None,
 'xticklabels': 'auto',
 'yticklabels': 'auto'}clstmap.allvals(){'annot': None,
 'annot_kws': None,
 'ax': None,
 'cbar': True,
 'cbar_ax': None,
 'cbar_kws': None,
 'cbar_pos': (0.02, 0.8, 0.05, 0.18),
 'center': None,
 'cmap': 'inferno',
 'col_cluster': True,
 'col_colors': None,
 'col_linkage': None,
 'colors_ratio': 0.03,
 'dendrogram_ratio': 0.2,
 'figsize': (10, 10),
 'fmt': '.2g',
 'linecolor': 'white',
 'linewidths': 0,
 'mask': None,
 'method': 'SINGLE',
 'metric': 'CORRELATION',
 'pivot_kws': None,
 'robust': True,
 'row_cluster': True,
 'row_colors': None,
 'row_linkage': None,
 'square': False,
 'standard_scale': None,
 'tree_kws': None,
 'vmax': None,
 'vmin': None,
 'xticklabels': 'auto',
 'yticklabels': 'auto',
 'z_score': 0}