Skip to content

Commit

Permalink
add description for sim_metric
Browse files Browse the repository at this point in the history
  • Loading branch information
srken32 committed Jul 24, 2024
1 parent 329f649 commit 77f7bea
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions nltools/stats.py
Original file line number Diff line number Diff line change
Expand Up @@ -1982,6 +1982,7 @@ def isc(
tail: (int) either 1 for one-tail or 2 for two-tailed test (default: 2)
n_jobs: (int) The number of CPUs to use to do the computation. -1 means all CPUs.
return_null: (bool) Return the permutation distribution along with the p-value; default False
sim_metric: (str) pairwise distance metric. See sklearn's pairwise_distances for valid inputs (default: correlation)
Returns:
stats: (dict) dictionary of permutation results ['correlation','p']
Expand Down

0 comments on commit 77f7bea

Please sign in to comment.