Skip to content

Commit

Permalink
cleaning up documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
psbhatt committed Aug 29, 2024
1 parent 203f8e5 commit 4c521c9
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
20 changes: 9 additions & 11 deletions docs/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,27 +20,25 @@ The iciktArray function can be accessed from the command line interface::

Either the "icikt" command or "python3 -m icikt" can be used to run the command line interface.

> icikt.py -h
> icikt -h
Usage:
icikt.py iciktArray <dataFilePath> [--data-format=<format>] [--replace=<globalNA>] [--mode=<perspective>] [--scale=<scaleMax>] [--diag=<diagGood>]
icikt.py iciktArray <dataFilePath> [--data-format=<format>] [--replace=<globalNA>] [--mode=<perspective>] [--scale=<scaleMax>] [--diag=<diagGood>] [--chunk=<chunkSize>] [--output=<outname>] [--include=<includeOnly>]
icikt.py leftCensor <dataFilePath> [--data-format=<format>] [--replace=<globalNA>] [--samples=<sampleClasses>]
icikt.py -h | --help
icikt.py --version

Using a csv file with no global replace values::

icikt.py iciktArray test.csv --data-format=csv --replace=None
icikt iciktArray test.csv --data-format=csv --replace=None

Using a tsv file with no global replace values::
Using a tsv file with no replacements and outputting the results with prefix of 'test'::

icikt.py iciktArray test.tsv --data-format=tsv --replace=None

Using a csv file with 0 as the replace value::

icikt.py iciktArray test.csv --data-format=csv
icikt iciktArray <insert_name>.tsv --data-format=tsv --replace= --output=test
Using a csv file in local mode with 0 as the replace value::
Using a csv file in local mode with 0 as the replace value, no scaling, no diagonal values, and a chunk size of 5::

icikt.py iciktArray test.csv --mode=local --data-format=csv
icikt iciktArray <insert_name>.csv --replace=0 --mode=local --scale=False --diag=False --chunk=5


Using icikt in a Python script
Expand Down
3 changes: 0 additions & 3 deletions src/icikt/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,6 @@
"""

# from icikt.methods import iciktArray
# from icikt.left_censorship import leftCensorTest
# from icikt import __version__ as ver
import icikt
import multiprocessing
import docopt
Expand Down
7 changes: 6 additions & 1 deletion src/icikt/kendall_dis.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,10 @@


def kendall_dis(x, y):
# logging.error("Cython package is not properly installed")
"""
Returns the kendall tau distance between two arrays
:param x: First array of data
:param y: Second array of data
"""
pass

0 comments on commit 4c521c9

Please sign in to comment.