ClusterInfo usage page

Version 1 by João Canhita
on Jul 26, 2013 15:15.

compared with
Current by João Canhita
on Jul 26, 2013 16:00.

Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (2)

View page history
ClusterInfo instructions page
|| Parameter || in params file || Description ||
| \--project-dir | DIRECTORY     | project directory |
| \--cluster-spectra | FILE     | Cluster spectra file (defaults to 'spectra/specs_ms.pklbin') |
| \--clusterbin | FILE           | Clustering binary data file |
| \--inputspectra | FILE         | Input spectra file list (txt format) |
| \--originalspectra | FILE     | Original spectra file list (txt format) |
| \--outdir | PATH | Output directory (defaults to .) |
| \--outfile | FILE             | Output filename (defaults to 'ClusterInfo.csv') |
| \--out-summary-file | FILE     | Output filename for the summary file (defaults to 'cluster_summary.tsv') |
| \--p | FILE                   | Read parameters from file |
| \--help | | Display this help and exit |
| \--version | | Output version information and exit |
| | GROUP_\* | Group names defined in the parameters file |
Groups must be defined in a params file, as below:

{code}
GROUP_G1=file1;file2;file3   # defines a group of 3 files, named G1
GROUP_G2=file4;file5  # defines a group of 2 files named G2
{code}
Example usage:

{code}
./clusterInfo --p parameterFile.txt  --outfile outputFileName.txt --out-summary-file mySummaryFile.txt  --cluster-spectra specs_ms.pklbin
{code}
.