ASAP icon indicating copy to clipboard operation
ASAP copied to clipboard

documentation of python interface

Open bernstei opened this issue 4 years ago • 4 comments

It would be great if the python interface had some documentation (as opposed to just the command line)

bernstei avatar Aug 27 '20 23:08 bernstei

Hi. Yes I'm working on the documentation. The python package itself is quite well-documented (https://bingqingcheng.github.io/modules.html), and in the near future I'll add some examples on how to import the functionalities of asaplib

BingqingCheng avatar Aug 28 '20 12:08 BingqingCheng

Thanks - that's a good start. I'm trying to figure out how to do the multiple maps on the same axes from issue #52 (or at least same PCA vectors), and the asaplib howto seems like it's pointing me in a useful direction. However, my best guess is that I have to replace the dreducer.fit_transform with fit for the entire design matrix, then transform and plot for each subset. I'll can try to see if that's enough, and ask for more specific docs here if it's not.

bernstei avatar Aug 28 '20 20:08 bernstei

The asaplib.reducedim.dim_reducer module can already do what you want (reduce_dim using one set of data, and project anything else). What needs to be modified is the asaplib.plot.plotters class: for now it plots everything on one plot, and one can extend it to give the option to do subplots.

BingqingCheng avatar Aug 31 '20 10:08 BingqingCheng

BTW, I'm refining the documentation. If you have any suggestions pls let me know!

BingqingCheng avatar Aug 31 '20 10:08 BingqingCheng