Documentation for base
module
bengrn.base
bengrn base module.
Classes:
Name | Description |
---|---|
BenGRN |
|
Functions:
Name | Description |
---|---|
compute_epr |
compute_epr computes the Expected Precision Recall (EPR) metric for the given classifier, test data, and true labels. |
compute_genie3 |
This function computes the GENIE3 algorithm on the given data. |
compute_pr |
compute_pr computes the precision and recall metrics for the given GRN and true matrix. |
download_perturb_gt |
download_perturb_gt downloads the genome wide perturb seq ground truth data. |
get_GT_db |
use_prior_network loads a prior GRN from a list of available networks. |
get_perturb_gt |
get_perturb_gt retrieves the genome wide perturb seq ground truth data. |
get_scenicplus |
This function retrieves a loomx scenicplus data from a given file path and loads it as a GrnnData |
get_sroy_gt |
This function retrieves the ground truth data from the McCall et al.'s paper. |
load_genes |
load_genes loads the genes for the given organisms. |
precision_recall |
Calculate precision and recall from the true and predicted connections. |
train_classifier |
train_classifier trains a classifier to generate a GRN that maps to the ground truth. |
BenGRN
Initializes the BenGRN class.
Parameters: |
|
---|
Methods:
Name | Description |
---|---|
compare_to |
compare_to compares the GRN to another GRN. |
scprint_benchmark |
scprint_benchmark full benchmarks of the GRN as in the scPRINT paper. |
Source code in bengrn/base.py
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
|
compare_to
compare_to compares the GRN to another GRN.
Parameters: |
|
---|
Returns: |
|
---|
Source code in bengrn/base.py
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
|
scprint_benchmark
scprint_benchmark full benchmarks of the GRN as in the scPRINT paper.
It will apply first an enrichment analysis over the [elems] of the GRN looking for TF enrichment and cell type marker gene enrichment It will then apply an enrichment over each TF in the GRN for their targets in ENCODE. Finaly, it will compare it to the OmniPath database GRN using precision recall type metrics.
Parameters: |
|
---|
Returns: |
|
---|
Source code in bengrn/base.py
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 |
|
compute_epr
compute_epr computes the Expected Precision Recall (EPR) metric for the given classifier, test data, and true labels.
Parameters: |
|
---|
Returns: |
|
---|
Source code in bengrn/base.py
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 |
|
compute_genie3
This function computes the GENIE3 algorithm on the given data.
Parameters: |
|
---|
Returns: |
|
---|
Source code in bengrn/base.py
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 |
|
compute_pr
compute_pr computes the precision and recall metrics for the given GRN and true matrix.
Parameters: |
|
---|
Raises: |
|
---|
Returns: |
|
---|
Source code in bengrn/base.py
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 |
|
download_perturb_gt
download_perturb_gt downloads the genome wide perturb seq ground truth data.
Parameters: |
|
---|
Source code in bengrn/base.py
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 |
|
get_GT_db
use_prior_network loads a prior GRN from a list of available networks.
Parameters: |
|
---|
Returns: |
|
---|
Raises: |
|
---|
Source code in bengrn/base.py
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 |
|
get_perturb_gt
get_perturb_gt retrieves the genome wide perturb seq ground truth data.
Parameters: |
|
---|
Returns: |
|
---|
Source code in bengrn/base.py
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 |
|
get_scenicplus
This function retrieves a loomx scenicplus data from a given file path and loads it as a GrnnData
Parameters: |
|
---|
Raises: |
|
---|
Returns: |
|
---|
Source code in bengrn/base.py
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 |
|
get_sroy_gt
This function retrieves the ground truth data from the McCall et al.'s paper.
Parameters: |
|
---|
Returns: |
|
---|
Source code in bengrn/base.py
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 |
|
load_genes
load_genes loads the genes for the given organisms.
Parameters: |
|
---|
Returns: |
|
---|
Source code in bengrn/base.py
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 |
|
precision_recall
Calculate precision and recall from the true and predicted connections.
Parameters: |
|
---|
Returns: |
|
---|
Source code in bengrn/base.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
|
train_classifier
train_classifier trains a classifier to generate a GRN that maps to the ground truth.
Uses a RidgeClassifier to select the best combination of networks to predict the ground truth. It is used for the head classification part in the scPRINT paper.
Parameters: |
|
---|
Returns: |
|
---|
Source code in bengrn/base.py
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 |
|