dorzhey / scgog

Single Cell data processing and analysis
MIT License
0 stars 1 forks source link

Docstring for data_processing.py #4

Open krthkkrv opened 8 months ago

krthkkrv commented 8 months ago

The code is readable but will benefit from more detailed docstring for the functions. For example,

  1. For the two functions that read in a file, the file type can be explained; tab-separated file, .csv or .txt file
  2. For the quality_control() function, are the quality controls for the two datasets as well as the filter thresholds standard parameters for this type of dataset? Elaborating on why they were set up as such would be helpful.

The docstrings for the merge function looks great!

dorzhey commented 8 months ago
  1. Will be done
  2. Yes, thank you for pointing out these issues. Most of the QC and its values are taken from either previous work or relevant literature. You are right in sense that I need to address this, however it will basically always be defined by some thresholds depending on the application and the dataset.