Skip to content

Commit 240fea2

Browse files
committed
feat: Refactor co-occurrence analysis functions
1 parent 7c0d399 commit 240fea2

File tree

3 files changed

+0
-29
lines changed

3 files changed

+0
-29
lines changed

src/cooccur.jl

-9
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,6 @@ This function creates a species by species matrix of potential co-occurring site
5050
5151
# Returns
5252
A species by species matrix where the upper triangle contains N for each species pair.
53-
54-
# Examples
55-
```julia
56-
# Define a binary species by site matrix
57-
# species_matrix = rand(Bool, num_species, num_sites)
58-
59-
# Calculate the co-occurrence matrix N
60-
# cooccurrence_matrix = create_N_matrix(species_matrix)
61-
```
6253
"""
6354
function calculate_cooccurrence_matrix(mat::Matrix{Int})
6455
num_species = size(mat, 1)

src/lr_enrichment.jl

-10
Original file line numberDiff line numberDiff line change
@@ -122,11 +122,6 @@ Find LR (Ligand Receptor) pairs that are significantly co-occurring in one group
122122
123123
# Returns
124124
List of LR pairs enriched in Group 1 and not in Group 2.
125-
126-
# Example
127-
```julia
128-
result = find_differentially_cooccurring_LR_pairs(cooc_df_1, cooc_df_2, 0.05, 0.1)
129-
```
130125
"""
131126
function find_differentially_cooccurring_LR_pairs(
132127
cooc_df_1::DataFrame,
@@ -177,11 +172,6 @@ Find LR (Ligand Receptor) pairs that are significantly co-occurring in one group
177172
178173
# Returns
179174
List of LR pairs enriched in Group 1 and not in Group 2.
180-
181-
# Example
182-
```julia
183-
result = find_differentially_cooccurring_LR_pairs(group1_results, group2_results, 0.05, 0.1)
184-
```
185175
"""
186176
function find_differentially_cooccurring_LR_pairs(
187177
group1_results::Dict{String, Any},

src/utils.jl

-10
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,6 @@ Calculate effect sizes for co-occurrence analysis results.
99
1010
# Returns
1111
Effect sizes as a data frame.
12-
13-
# Example
14-
```julia
15-
effect_sizes(cooccur_object)
16-
```
1712
"""
1813
function effect_sizes(cooccur; standardized=true)
1914
cooccur_results = cooccur[:results]
@@ -62,11 +57,6 @@ Summarize the results of a co-occurrence analysis.
6257
6358
# Returns
6459
A summary of the co-occurrence analysis results as a dictionary.
65-
66-
# Example
67-
```julia
68-
summary = summarize_cooccur(cooccur_object)
69-
```
7060
"""
7161
function summarize_cooccur(cooccur::CooccurOutput)
7262
# Print basic analysis information

0 commit comments

Comments
 (0)