cyxss / HCAd_Client

HCAd_Client

requirements

Install the requirements.

pip install -r requirements.txt

Usage

接口：

1. HCAd_Client.Setup_Client(endpoint, access_key_id, access_key_secret, instance_name, table_name)

   用于连接服务器

2. `HCAd_Client.insert_matrix(df_expression, df_annotation, genenum_chk, start_row = 0)

   用于上传数据，如果用于非人类的转录组数据（基因数不等于43878）请将genenum_chk设置为False. start_row用于决定从df_annotation矩阵的哪一行开始上传

3. HCAd_Client.build_index()

   用于建立索引

4. HCAd_Client.query_cells(conditions)

   用于搜索符合条件的数据，输入字符串，返回符合要求的行的主键组成的List。

   字符串为逻辑表达式，可以带括号，如：

   "donor_age== 47yr && organ ==   Heart && (hcad_name==Heart-Connective Tissue-T cell-CCL5 CST7 || hcad_name==Heart-Musle Tissue-Smooth muscle cell-PPP1R15A JUNB )"

   与关系：&&； 或关系：||； 非关系： !； 等于： ==； 不等于 <>;

   注：正常的空格并不影响，但最好不要再字符串尾部出现多余空格，不然有几率bug

5. HCAd_Client.get_columnsbycell(rows_to_get,cols_to_get,col_condition)

   根据需要的行和需要的列，返回pd.Dataframe;

   如果需要返回全部列，则cols_to_get = None;

   col_condition可以传入一个过滤器（filter),

6. HCAd_Client.get_column_set(col_to_get, col_condition=None)

   返回所需列的全部无重复元素集合，返回类型为List。参数类型同5。col_condition为可选参数。

   *注：col_to_get列表长度必须为1。

7. HCAd_Client.get_all_rows(cols_to_get=[])

   返回指定列的所有行数据，返回类型为List，默认返回所有列。

   可选参数cols_to_get为所需列列名的list。

8. HCAd_Client.update_row(primary_key, update_data) & HCAd_Client.update_batch(rows_to_update, update_sets)

   更新行数据。

   update_row用于更新单行数据

   primary_key 是主键，如[('study_id','10.1038/s41467-019-10756-2'), ('cell_id','human_control-AAACCTGAGCTGAAAT'),('user_id',3)] updtae_data 是待更新的列的list，如[(col1,val1),(col2,val2)]

   update_batch用于更新多行数据，传入的参数为update_row接口传入参数的列表。

ChangeLog

2020.10.14 v1.4.3

• 改变了insert_matrix方法中的输入正确性检查内容，加入了参数genenum_chk，用于决定是否要检查基因数；加入了对df_expression和df_annotation细胞顺序是否一致的检查。
• 更新了数据上传异常的断点机制，出现异常会停止上传，并返回未上传部分的起始行号。通过insert_matrix方法的start_row参数可以选择从哪一行（哪一个细胞)开始上传。

2020.10.13 v1.4.2

• 添加了update_row和update_batch方法，用于更新表内已有的数据。
• 加入了数据上传异常的断点机制，出现异常会停止上传，并返回未上传的dataframe数据。

2020.09.19 v1.4.1

• Bug fixed.

2020.09.18 v1.4

• 添加get_all_rows方法。如需获取所有行数据请使用该方法，效率更高。
• 更新了get_column_set方法。

2020.09.17 v1.3.1

• V1.3加入可以由逻辑表达转换为filter的 seq2filter(gene_condition), 表达式的使用方法类似于4.