comparison inspect.xml @ 11:6bd82ed14acd draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/scanpy/ commit aba2a85f5da6e1094f382d1f0d94c4b8f2544a7d
author iuc
date Wed, 08 Nov 2023 14:48:14 +0000
parents c5d3684f7c4c
children 3081ff5c84a3
comparison
equal deleted inserted replaced
10:c5d3684f7c4c 11:6bd82ed14acd
1 <tool id="scanpy_inspect" name="Inspect and manipulate" version="@galaxy_version@" profile="@profile@"> 1 <tool id="scanpy_inspect" name="Inspect and manipulate" version="@galaxy_version@" profile="@profile@">
2 <description> with scanpy</description> 2 <description> with scanpy</description>
3 <expand macro="bio_tools"/>
4 <macros> 3 <macros>
5 <import>macros.xml</import> 4 <import>macros.xml</import>
6 <xml name="score_genes_params"> 5 <xml name="score_genes_params">
7 <param argument="n_bins" type="integer" value="25" label="Number of expression level bins for sampling" help=""/> 6 <param argument="n_bins" type="integer" value="25" label="Number of expression level bins for sampling" help=""/>
8 <param argument="random_state" type="integer" value="0" label="Random seed for sampling" help=""/> 7 <param argument="random_state" type="integer" value="0" label="Random seed for sampling" help=""/>
49 <xml name="random_state"> 48 <xml name="random_state">
50 <param argument="random_state" type="integer" value="" optional="true" 49 <param argument="random_state" type="integer" value="" optional="true"
51 label="The seed of the pseudo random number generator to use when shuffling the data" help=""/> 50 label="The seed of the pseudo random number generator to use when shuffling the data" help=""/>
52 </xml> 51 </xml>
53 </macros> 52 </macros>
53 <expand macro="bio_tools"/>
54 <expand macro="requirements"/> 54 <expand macro="requirements"/>
55 <expand macro="version_command"/> 55 <expand macro="version_command"/>
56 <command detect_errors="exit_code"><![CDATA[ 56 <command detect_errors="exit_code"><![CDATA[
57 @CMD@ 57 @CMD@
58 ]]></command> 58 ]]></command>
451 <param argument="c" type="float" value="1.0" label="Inverse of regularization strength" 451 <param argument="c" type="float" value="1.0" label="Inverse of regularization strength"
452 help="It must be a positive float. Like in support vector machines, smaller values specify stronger regularization."/> 452 help="It must be a positive float. Like in support vector machines, smaller values specify stronger regularization."/>
453 </when> 453 </when>
454 </conditional> 454 </conditional>
455 </when> 455 </when>
456 <!--<when value="tl.marker_gene_overlap"> 456 <!-- With inplace=True, NotImplementedError: Writing Pandas dataframes to h5ad is currently under development. Please use `inplace=False`. -->
457 <!-- <when value="tl.marker_gene_overlap">
457 <repeat name="reference_markers" title="Marker genes"> 458 <repeat name="reference_markers" title="Marker genes">
458 <param name="key" type="text" value="" label="Cell identity name" help=""/> 459 <param name="key" type="text" value="" label="Cell identity name" help=""/>
459 <param name="values" type="text" value="" label="List of genes" help="Comma-separated names from 'var'"/> 460 <param name="values" type="text" value="" label="List of genes" help="Comma-separated names from 'var'"/>
460 </repeat> 461 </repeat>
461 <param argument="key" type="text" value="rank_genes_groups" label="Key in adata.uns where the rank_genes_groups output is stored"/> 462 <param argument="key" type="text" value="rank_genes_groups" label="Key in adata.uns where the rank_genes_groups output is stored"/>
475 <when value="overlap_coef"/> 476 <when value="overlap_coef"/>
476 <when value="jaccard"/> 477 <when value="jaccard"/>
477 </conditional> 478 </conditional>
478 <param argument="top_n_markers" type="integer" optional="true" label="Number of top data-derived marker genes to use" help="By default all calculated marker genes are used. If adj_pval_threshold is set along with top_n_markers, then adj_pval_threshold is ignored."/> 479 <param argument="top_n_markers" type="integer" optional="true" label="Number of top data-derived marker genes to use" help="By default all calculated marker genes are used. If adj_pval_threshold is set along with top_n_markers, then adj_pval_threshold is ignored."/>
479 <param argument="adj_pval_threshold" type="float" optional="true" label="Significance threshold on the adjusted p-values to select marker genes" help=" This can only be used when adjusted p-values are calculated by 'tl.rank_genes_groups'. If adj_pval_threshold is set along with top_n_markers, then adj_pval_threshold is ignored."/> 480 <param argument="adj_pval_threshold" type="float" optional="true" label="Significance threshold on the adjusted p-values to select marker genes" help=" This can only be used when adjusted p-values are calculated by 'tl.rank_genes_groups'. If adj_pval_threshold is set along with top_n_markers, then adj_pval_threshold is ignored."/>
480 <param argument="key_added" type="text" value="" optional="true" label="Key that will contain the marker overlap scores in 'uns'"/> 481 <param argument="key_added" type="text" value="marker_gene_overlap" optional="true" label="Key that will contain the marker overlap scores in 'uns'"/>
481 </when>--> 482 </when>-->
482 <when value="pp.log1p"/> 483 <when value="pp.log1p"/>
483 <when value="pp.scale"> 484 <when value="pp.scale">
484 <param argument="zero_center" type="boolean" truevalue="True" falsevalue="False" checked="true" 485 <param argument="zero_center" type="boolean" truevalue="True" falsevalue="False" checked="true"
485 label="Zero center?" help="If not, it omits zero-centering variables, which allows to handle sparse input efficiently."/> 486 label="Zero center?" help="If not, it omits zero-centering variables, which allows to handle sparse input efficiently."/>
492 </inputs> 493 </inputs>
493 <outputs> 494 <outputs>
494 <expand macro="anndata_outputs"/> 495 <expand macro="anndata_outputs"/>
495 </outputs> 496 </outputs>
496 <tests> 497 <tests>
497 <test> 498 <test expect_num_outputs="2">
498 <!-- test 0 --> 499 <!-- test 1 -->
499 <param name="adata" value="sparce_csr_matrix.h5ad" /> 500 <param name="adata" value="sparce_csr_matrix.h5ad" />
500 <conditional name="method"> 501 <conditional name="method">
501 <param name="method" value="pp.calculate_qc_metrics"/> 502 <param name="method" value="pp.calculate_qc_metrics"/>
502 <param name="expr_type" value="counts"/> 503 <param name="expr_type" value="counts"/>
503 <param name="var_type" value="genes"/> 504 <param name="var_type" value="genes"/>
515 <has_text_matching expression="qc_vars=\['mito', 'negative'\]" /> 516 <has_text_matching expression="qc_vars=\['mito', 'negative'\]" />
516 </assert_contents> 517 </assert_contents>
517 </output> 518 </output>
518 <output name="anndata_out" file="pp.calculate_qc_metrics.sparce_csr_matrix.h5ad" ftype="h5ad" compare="sim_size"/> 519 <output name="anndata_out" file="pp.calculate_qc_metrics.sparce_csr_matrix.h5ad" ftype="h5ad" compare="sim_size"/>
519 </test> 520 </test>
520 <test> 521 <test expect_num_outputs="2">
521 <!-- test 1 --> 522 <!-- test 2 -->
522 <param name="adata" value="pp.recipe_weinreb17.paul15_subsample.h5ad" /> 523 <param name="adata" value="pp.recipe_weinreb17.paul15_subsample.h5ad" />
523 <conditional name="method"> 524 <conditional name="method">
524 <param name="method" value="pp.neighbors"/> 525 <param name="method" value="pp.neighbors"/>
525 <param name="n_neighbors" value="15"/> 526 <param name="n_neighbors" value="15"/>
526 <param name="knn" value="True"/> 527 <param name="knn" value="True"/>
545 <assert_contents> 546 <assert_contents>
546 <has_h5_keys keys="X, obs, obsm, uns, var" /> 547 <has_h5_keys keys="X, obs, obsm, uns, var" />
547 </assert_contents> 548 </assert_contents>
548 </output> 549 </output>
549 </test> 550 </test>
550 <test> 551 <test expect_num_outputs="2">
551 <!-- test 2 --> 552 <!-- test 3 -->
552 <param name="adata" value="pp.recipe_weinreb17.paul15_subsample.h5ad" /> 553 <param name="adata" value="pp.recipe_weinreb17.paul15_subsample.h5ad" />
553 <conditional name="method"> 554 <conditional name="method">
554 <param name="method" value="pp.neighbors"/> 555 <param name="method" value="pp.neighbors"/>
555 <param name="n_neighbors" value="15"/> 556 <param name="n_neighbors" value="15"/>
556 <param name="knn" value="True"/> 557 <param name="knn" value="True"/>
570 <has_text_matching expression="metric='braycurtis'"/> 571 <has_text_matching expression="metric='braycurtis'"/>
571 </assert_contents> 572 </assert_contents>
572 </output> 573 </output>
573 <output name="anndata_out" file="pp.neighbors_gauss_braycurtis.recipe_weinreb17.paul15_subsample.h5ad" ftype="h5ad" compare="sim_size"/> 574 <output name="anndata_out" file="pp.neighbors_gauss_braycurtis.recipe_weinreb17.paul15_subsample.h5ad" ftype="h5ad" compare="sim_size"/>
574 </test> 575 </test>
575 <test> 576 <test expect_num_outputs="2">
576 <!-- test 3 --> 577 <!-- test 4 -->
577 <param name="adata" value="krumsiek11.h5ad" /> 578 <param name="adata" value="krumsiek11.h5ad" />
578 <conditional name="method"> 579 <conditional name="method">
579 <param name="method" value="tl.score_genes"/> 580 <param name="method" value="tl.score_genes"/>
580 <param name="gene_list" value="Gata2, Fog1"/> 581 <param name="gene_list" value="Gata2, Fog1"/>
581 <param name="ctrl_size" value="2"/> 582 <param name="ctrl_size" value="2"/>
599 <has_text_matching expression="copy=False" /> 600 <has_text_matching expression="copy=False" />
600 </assert_contents> 601 </assert_contents>
601 </output> 602 </output>
602 <output name="anndata_out" file="tl.score_genes.krumsiek11.h5ad" ftype="h5ad" compare="sim_size"/> 603 <output name="anndata_out" file="tl.score_genes.krumsiek11.h5ad" ftype="h5ad" compare="sim_size"/>
603 </test> 604 </test>
604 <test> 605 <test expect_num_outputs="2">
605 <!-- test 4 --> 606 <!-- test 5 -->
606 <param name="adata" value="krumsiek11.h5ad" /> 607 <param name="adata" value="krumsiek11.h5ad" />
607 <conditional name="method"> 608 <conditional name="method">
608 <param name="method" value="tl.score_genes_cell_cycle"/> 609 <param name="method" value="tl.score_genes_cell_cycle"/>
609 <conditional name='s_genes'> 610 <conditional name='s_genes'>
610 <param name="format" value="text"/> 611 <param name="format" value="text"/>
631 <has_text_matching expression="use_raw=False"/> 632 <has_text_matching expression="use_raw=False"/>
632 </assert_contents> 633 </assert_contents>
633 </output> 634 </output>
634 <output name="anndata_out" file="tl.score_genes_cell_cycle.krumsiek11.h5ad" ftype="h5ad" compare="sim_size"/> 635 <output name="anndata_out" file="tl.score_genes_cell_cycle.krumsiek11.h5ad" ftype="h5ad" compare="sim_size"/>
635 </test> 636 </test>
636 <test> 637 <test expect_num_outputs="2">
637 <!-- test 5 --> 638 <!-- test 6 -->
638 <param name="adata" value="krumsiek11.h5ad" /> 639 <param name="adata" value="krumsiek11.h5ad" />
639 <conditional name="method"> 640 <conditional name="method">
640 <param name="method" value="tl.rank_genes_groups"/> 641 <param name="method" value="tl.rank_genes_groups"/>
641 <param name="groupby" value="cell_type"/> 642 <param name="groupby" value="cell_type"/>
642 <param name="use_raw" value="True"/> 643 <param name="use_raw" value="False"/>
643 <conditional name="ref"> 644 <conditional name="ref">
644 <param name="rest" value="rest"/> 645 <param name="rest" value="rest"/>
645 </conditional> 646 </conditional>
646 <param name="n_genes" value="100"/> 647 <param name="n_genes" value="100"/>
647 <conditional name="tl_rank_genes_groups_method"> 648 <conditional name="tl_rank_genes_groups_method">
654 </section> 655 </section>
655 <output name="hidden_output"> 656 <output name="hidden_output">
656 <assert_contents> 657 <assert_contents>
657 <has_text_matching expression="sc.tl.rank_genes_groups"/> 658 <has_text_matching expression="sc.tl.rank_genes_groups"/>
658 <has_text_matching expression="groupby='cell_type'"/> 659 <has_text_matching expression="groupby='cell_type'"/>
659 <has_text_matching expression="use_raw=True"/> 660 <has_text_matching expression="use_raw=False"/>
660 <has_text_matching expression="reference='rest'"/> 661 <has_text_matching expression="reference='rest'"/>
661 <has_text_matching expression="n_genes=100"/> 662 <has_text_matching expression="n_genes=100"/>
662 <has_text_matching expression="method='t-test_overestim_var'"/> 663 <has_text_matching expression="method='t-test_overestim_var'"/>
663 <has_text_matching expression="corr_method='benjamini-hochberg'"/> 664 <has_text_matching expression="corr_method='benjamini-hochberg'"/>
664 </assert_contents> 665 </assert_contents>
665 </output> 666 </output>
666 <output name="anndata_out" file="tl.rank_genes_groups.krumsiek11.h5ad" ftype="h5ad" compare="sim_size"/> 667 <output name="anndata_out" file="tl.rank_genes_groups.krumsiek11.h5ad" ftype="h5ad" compare="sim_size"/>
667 </test> 668 </test>
668 <test> 669 <test expect_num_outputs="2">
669 <!-- test 6 --> 670 <!-- test 7 -->
670 <param name="adata" value="pbmc68k_reduced.h5ad" /> 671 <param name="adata" value="pbmc68k_reduced.h5ad" />
671 <conditional name="method"> 672 <conditional name="method">
672 <param name="method" value="tl.rank_genes_groups"/> 673 <param name="method" value="tl.rank_genes_groups"/>
673 <param name="groupby" value="louvain"/> 674 <param name="groupby" value="louvain"/>
674 <param name="use_raw" value="True"/> 675 <param name="use_raw" value="True"/>
712 <assert_contents> 713 <assert_contents>
713 <has_h5_keys keys="X, obs, obsm, raw/X, raw/var, uns, var" /> 714 <has_h5_keys keys="X, obs, obsm, raw/X, raw/var, uns, var" />
714 </assert_contents> 715 </assert_contents>
715 </output> 716 </output>
716 </test> 717 </test>
717 <test> 718 <test expect_num_outputs="2">
718 <!-- test 7 --> 719 <!-- test 8 -->
719 <param name="adata" value="pbmc68k_reduced.h5ad" /> 720 <param name="adata" value="pbmc68k_reduced.h5ad" />
720 <conditional name="method"> 721 <conditional name="method">
721 <param name="method" value="tl.rank_genes_groups"/> 722 <param name="method" value="tl.rank_genes_groups"/>
722 <param name="groupby" value="louvain"/> 723 <param name="groupby" value="louvain"/>
723 <param name="use_raw" value="True"/> 724 <param name="use_raw" value="True"/>
767 <assert_contents> 768 <assert_contents>
768 <has_h5_keys keys="X, obs, obsm, raw/X, raw/var, uns, var" /> 769 <has_h5_keys keys="X, obs, obsm, raw/X, raw/var, uns, var" />
769 </assert_contents> 770 </assert_contents>
770 </output> 771 </output>
771 </test> 772 </test>
772 <!--<test> 773 <!-- test expect_num_outputs="2">
773 < test 9 > 774 < test 9 tl.marker_gene_overlap function was commented because inpace=True does not work>
774 <param name="adata" value="tl.rank_genes_groups.louvain.neighbors.pca.pbmc68k_reduced.h5ad" /> 775 <param name="adata" value="tl.rank_genes_groups.newton-cg.pbmc68k_reduced.h5ad" />
775 <conditional name="method"> 776 <conditional name="method">
776 <param name="method" value="tl.marker_gene_overlap"/> 777 <param name="method" value="tl.marker_gene_overlap"/>
777 <repeat name="reference_markers"> 778 <repeat name="reference_markers">
778 <param name="key" value="CD4 T cells"/> 779 <param name="key" value="CD4 T cells"/>
779 <param name="value" value="IL7R"/> 780 <param name="value" value="IL7R"/>
785 <repeat name="reference_markers"> 786 <repeat name="reference_markers">
786 <param name="key" value="B cells"/> 787 <param name="key" value="B cells"/>
787 <param name="value" value="MS4A1"/> 788 <param name="value" value="MS4A1"/>
788 </repeat> 789 </repeat>
789 <conditional name="overlap"> 790 <conditional name="overlap">
790 <param argument="method" value="overlap_count"/> 791 <param name="method" value="overlap_count"/>
791 <param argument="normalize" value="None"/> 792 <param name="normalize" value="None"/>
792 </conditional> 793 </conditional>
793 </conditional> 794 </conditional>
794 <assert_stdout> 795 <assert_stdout>
795 <has_text_matching expression="tl.marker_gene_overlap"/> 796 <has_text_matching expression="tl.marker_gene_overlap"/>
796 <has_text_matching expression="key='rank_genes_groups'"/> 797 <has_text_matching expression="key='rank_genes_groups'"/>
797 <has_text_matching expression="method='overlap_count'"/> 798 <has_text_matching expression="method='overlap_count'"/>
798 </assert_stdout> 799 </assert_stdout>
800 <output name="anndata_out" file="tl.marker_gene_overlap.pbmc68k_reduced.h5ad" ftype="h5ad" compare="sim_size"/>
801 </test> -->
802 <test expect_num_outputs="2">
803 <!-- test 10 -->
804 <param name="adata" value="krumsiek11.h5ad" />
805 <conditional name="method">
806 <param name="method" value="pp.log1p"/>
807 </conditional>
808 <section name="advanced_common">
809 <param name="show_log" value="true" />
810 </section>
811 <output name="hidden_output">
812 <assert_contents>
813 <has_text_matching expression="sc.pp.log1p"/>
814 </assert_contents>
815 </output>
799 <output name="anndata_out" file="pp.log1p.krumsiek11.h5ad" ftype="h5ad" compare="sim_size"/> 816 <output name="anndata_out" file="pp.log1p.krumsiek11.h5ad" ftype="h5ad" compare="sim_size"/>
800 </test>--> 817 </test>
801 <test> 818 <test expect_num_outputs="2">
802 <!-- test 8 --> 819 <!-- test 11 -->
803 <param name="adata" value="krumsiek11.h5ad" />
804 <conditional name="method">
805 <param name="method" value="pp.log1p"/>
806 </conditional>
807 <section name="advanced_common">
808 <param name="show_log" value="true" />
809 </section>
810 <output name="hidden_output">
811 <assert_contents>
812 <has_text_matching expression="sc.pp.log1p"/>
813 </assert_contents>
814 </output>
815 <output name="anndata_out" file="pp.log1p.krumsiek11.h5ad" ftype="h5ad" compare="sim_size"/>
816 </test>
817 <test>
818 <!-- test 9 -->
819 <param name="adata" value="krumsiek11.h5ad" /> 820 <param name="adata" value="krumsiek11.h5ad" />
820 <conditional name="method"> 821 <conditional name="method">
821 <param name="method" value="pp.scale"/> 822 <param name="method" value="pp.scale"/>
822 <param name="zero_center" value="true"/> 823 <param name="zero_center" value="true"/>
823 </conditional> 824 </conditional>
830 <has_text_matching expression="zero_center=True"/> 831 <has_text_matching expression="zero_center=True"/>
831 </assert_contents> 832 </assert_contents>
832 </output> 833 </output>
833 <output name="anndata_out" file="pp.scale.krumsiek11.h5ad" ftype="h5ad" compare="sim_size"/> 834 <output name="anndata_out" file="pp.scale.krumsiek11.h5ad" ftype="h5ad" compare="sim_size"/>
834 </test> 835 </test>
835 <test> 836 <test expect_num_outputs="2">
836 <!-- test 10 --> 837 <!-- test 12 -->
837 <param name="adata" value="krumsiek11.h5ad" /> 838 <param name="adata" value="krumsiek11.h5ad" />
838 <conditional name="method"> 839 <conditional name="method">
839 <param name="method" value="pp.scale"/> 840 <param name="method" value="pp.scale"/>
840 <param name="zero_center" value="true"/> 841 <param name="zero_center" value="true"/>
841 <param name="max_value" value="10"/> 842 <param name="max_value" value="10"/>
850 <has_text_matching expression="max_value=10.0"/> 851 <has_text_matching expression="max_value=10.0"/>
851 </assert_contents> 852 </assert_contents>
852 </output> 853 </output>
853 <output name="anndata_out" file="pp.scale_max_value.krumsiek11.h5ad" ftype="h5ad" compare="sim_size"/> 854 <output name="anndata_out" file="pp.scale_max_value.krumsiek11.h5ad" ftype="h5ad" compare="sim_size"/>
854 </test> 855 </test>
855 <test> 856 <test expect_num_outputs="2">
856 <!-- test 11 --> 857 <!-- test 13 -->
857 <param name="adata" value="krumsiek11.h5ad" /> 858 <param name="adata" value="krumsiek11.h5ad" />
858 <conditional name="method"> 859 <conditional name="method">
859 <param name="method" value="pp.sqrt"/> 860 <param name="method" value="pp.sqrt"/>
860 </conditional> 861 </conditional>
861 <section name="advanced_common"> 862 <section name="advanced_common">
890 - mean_{expr_type} (e.g. "mean counts", mean expression over all cells) 891 - mean_{expr_type} (e.g. "mean counts", mean expression over all cells)
891 - n_cells_by_{expr_type} (e.g. "n_cells_by_counts", number of cells this expression is measured in) 892 - n_cells_by_{expr_type} (e.g. "n_cells_by_counts", number of cells this expression is measured in)
892 - pct_dropout_by_{expr_type} (e.g. "pct_dropout_by_counts", percentage of cells this feature does not appear in) 893 - pct_dropout_by_{expr_type} (e.g. "pct_dropout_by_counts", percentage of cells this feature does not appear in)
893 894
894 More details on the `scanpy documentation 895 More details on the `scanpy documentation
895 <https://icb-scanpy.readthedocs-hosted.com/en/@version@/api/scanpy.pp.calculate_qc_metrics.html>`__ 896 <https://icb-scanpy.readthedocs-hosted.com/en/stable/api/scanpy.pp.calculate_qc_metrics.html>`__
896 897
897 Compute a neighborhood graph of observations, using `pp.neighbors` 898 Compute a neighborhood graph of observations, using `pp.neighbors`
898 ================================================================== 899 ==================================================================
899 900
900 The neighbor search efficiency of this heavily relies on UMAP (McInnes et al, 2018), 901 The neighbor search efficiency of this heavily relies on UMAP (McInnes et al, 2018),
909 - Distances for each pair of neighbors (distances) 910 - Distances for each pair of neighbors (distances)
910 911
911 This data are stored in the unstructured annotation (uns) and can be accessed using the inspect tool for AnnData objects 912 This data are stored in the unstructured annotation (uns) and can be accessed using the inspect tool for AnnData objects
912 913
913 More details on the `scanpy documentation 914 More details on the `scanpy documentation
914 <https://icb-scanpy.readthedocs-hosted.com/en/@version@/api/scanpy.pp.neighbors.html>`__ 915 <https://icb-scanpy.readthedocs-hosted.com/en/stable/api/scanpy.pp.neighbors.html>`__
915 916
916 Score a set of genes, using `tl.score_genes` 917 Score a set of genes, using `tl.score_genes`
917 ============================================ 918 ============================================
918 919
919 The score is the average expression of a set of genes subtracted with the 920 The score is the average expression of a set of genes subtracted with the
922 923
923 This reproduces the approach in Seurat (Satija et al, 2015) and has been implemented 924 This reproduces the approach in Seurat (Satija et al, 2015) and has been implemented
924 for Scanpy by Davide Cittaro. 925 for Scanpy by Davide Cittaro.
925 926
926 More details on the `scanpy documentation 927 More details on the `scanpy documentation
927 <https://icb-scanpy.readthedocs-hosted.com/en/@version@/api/scanpy.tl.score_genes.html>`__ 928 <https://icb-scanpy.readthedocs-hosted.com/en/stable/api/scanpy.tl.score_genes.html>`__
928 929
929 Score cell cycle genes, using `tl.score_genes_cell_cycle` 930 Score cell cycle genes, using `tl.score_genes_cell_cycle`
930 ========================================================= 931 =========================================================
931 932
932 Given two lists of genes associated to S phase and G2M phase, calculates 933 Given two lists of genes associated to S phase and G2M phase, calculates
933 scores and assigns a cell cycle phase (G1, S or G2M). See 934 scores and assigns a cell cycle phase (G1, S or G2M). See
934 `score_genes` for more explanation. 935 `score_genes` for more explanation.
935 936
936 More details on the `scanpy documentation 937 More details on the `scanpy documentation
937 <https://icb-scanpy.readthedocs-hosted.com/en/@version@/api/scanpy.tl.score_genes_cell_cycle.html>`__ 938 <https://icb-scanpy.readthedocs-hosted.com/en/stable/api/scanpy.tl.score_genes_cell_cycle.html>`__
938 939
939 Rank genes for characterizing groups, using `tl.rank_genes_groups` 940 Rank genes for characterizing groups, using `tl.rank_genes_groups`
940 ================================================================== 941 ==================================================================
941 942
942 The returned AnnData object contains: 943 The returned AnnData object contains:
948 - Ajusted p-values 949 - Ajusted p-values
949 950
950 This data are stored in the unstructured annotation (uns) and can be accessed using the inspect tool for AnnData objects 951 This data are stored in the unstructured annotation (uns) and can be accessed using the inspect tool for AnnData objects
951 952
952 More details on the `scanpy documentation 953 More details on the `scanpy documentation
953 <https://icb-scanpy.readthedocs-hosted.com/en/@version@/api/scanpy.tl.rank_genes_groups.html>`__ 954 <https://icb-scanpy.readthedocs-hosted.com/en/stable/api/scanpy.tl.rank_genes_groups.html>`__
954 955
955 956
956 Calculate an overlap score between data-deriven marker genes and provided markers (`tl.marker_gene_overlap`) 957 Calculate an overlap score between data-deriven marker genes and provided markers (`tl.marker_gene_overlap`)
957 ============================================================================================================ 958 ============================================================================================================
958 959
961 962
962 Logarithmize the data matrix (`pp.log1p`) 963 Logarithmize the data matrix (`pp.log1p`)
963 ========================================= 964 =========================================
964 965
965 More details on the `scanpy documentation 966 More details on the `scanpy documentation
966 <https://icb-scanpy.readthedocs-hosted.com/en/@version@/api/scanpy.pp.log1p.html>`__ 967 <https://icb-scanpy.readthedocs-hosted.com/en/stable/api/scanpy.pp.log1p.html>`__
967 968
968 Scale data to unit variance and zero mean (`pp.scale`) 969 Scale data to unit variance and zero mean (`pp.scale`)
969 ====================================================== 970 ======================================================
970 971
971 More details on the `scanpy documentation 972 More details on the `scanpy documentation
972 <https://icb-scanpy.readthedocs-hosted.com/en/@version@/api/scanpy.pp.scale.html>`__ 973 <https://icb-scanpy.readthedocs-hosted.com/en/stable/api/scanpy.pp.scale.html>`__
973 974
974 Computes the square root the data matrix (`pp.sqrt`) 975 Computes the square root the data matrix (`pp.sqrt`)
975 ==================================================== 976 ====================================================
976 977
977 `X = sqrt(X)` 978 `X = sqrt(X)`