scFEA icon indicating copy to clipboard operation
scFEA copied to clipboard

Input types

Open Hrovatin opened this issue 4 years ago • 9 comments

Could you add some documentation on what kind of inputs/file formats the tool accepts, e.g. expanding descriptions in

python src/scFEA.py --help

Hrovatin avatar Mar 29 '21 07:03 Hrovatin

More explanations are provided in the help option. Please check and run example data. You just need an SC gene expression matrix for input and do not need to change moduleGene and stoichiometry matrix parameters.

changwn avatar Mar 29 '21 16:03 changwn

I think that --test_file should be extended - e.g. noting that input for expression is CSV.

Hrovatin avatar Mar 30 '21 06:03 Hrovatin

Thank you for the suggestion @Hrovatin . For Smart-seq, some data provided on Gene Expression Omnibus (GEO) are txt format (example) thus I suggest the user transform data by themself. Since the computational tool are supposed to be run by a technician, we will not provide an interface for the smart-seq dataset. But we are planning a user-friendly web server in the future for biologists and doctors. For 10x chromium, I will extend the input interface to match the standard pipeline output. If you wish to contribute to this part, I can review it and merge into the master branch after accepted.

changwn avatar Mar 30 '21 16:03 changwn

I think you can add 10x reading function from Compass, they seem to have similar inputs https://github.com/YosefLab/Compass/blob/abc4456e0b4752b581b3fdfa68882d72e60ab307/compass/utils.py#L56

Hrovatin avatar Apr 02 '21 13:04 Hrovatin

Also, can you note whether the input should be raw counts, normalised counts, or normalised+log transformed counts.

Hrovatin avatar Apr 02 '21 14:04 Hrovatin

Also, can you note whether the input should be raw counts, normalised counts, or normalised+log transformed counts.

Thanks. The input can be raw counts or normalized counts. If the value greater than 30, we take log(value + 1 ) for raw counts. The instruction also added in --help function.

changwn avatar Apr 05 '21 19:04 changwn

Does this mean I can also input log-transformed normalised raw counts?

Hrovatin avatar Apr 06 '21 09:04 Hrovatin

Does this mean I can also input log-transformed normalised raw counts?

Yes, you can input log-transformed normalized counts.

changwn avatar Apr 07 '21 19:04 changwn

Just wanted to echo that it'd be great if the input format was specified a bit more in the docs. Also csvs become pretty unwieldy with large datasets so reading in 10X mtx format would also be helpful

yanwu2014 avatar Mar 30 '22 23:03 yanwu2014