skiml-cluster 0.0.6

No project description provided

skiml-cluster

---

Table of Contents

• Quickstart
• Installation
• License

Quickstart

For RIVM users, the best approach is to run skiml-cluster on a computing node of the HPC, instead of on the home node.

Step by step:

1. Run apollo-mapping on the samples you want to cluster, or find the apollo-mapping results of these samples.
2. Copy all SNP VCFs (<APOLLO-MAPPING-OUTPUT>/variants/snps/*.vcf) for the relevant samples to a single directory.
3. Run skiml-cluster as follows on the SNP VCF directory, which will submit a job to the HPC:

bsub -M 10G skiml-cluster run --input <INPUT FOLDER> --output <OUTPUT FOLDER>

It is also possible to run skiml-cluster locally (without submitting to the HPC):

skiml-cluster run --input <INPUT FOLDER> --output <OUTPUT FOLDER>

However, please do this with care as some steps might require a lot of resources if you're running a lot of samples.

Installation

pip install --user skiml-cluster

To update skiml-cluster to the most recent version, run:

pip install --user --upgrade skiml-cluster

Troubleshooting

Q: I get this error:

ValueError in file /home/boas/mambaforge/lib/python3.10/site-packages/skiml_cluster/workflow/Snakefile, line 16:
No VCF files found in input directory.

A: skiml-cluster looks for files ending in .vcf in the input folder. If zero files can be found with this exact extension, the pipeline will not run. Please make sure there are valid VCF files (preferably from apollo-mapping) in the input folder with the extension .vcf.

Q: I get this error:

ValueError in file /home/boas/mambaforge/lib/python3.10/site-packages/skiml_cluster/workflow/Snakefile, line 11:
Input directory does not exist.

A: The input directory cannot be found. Please make sure there are no typos in the skiml-cluster command.

Methodology

skiml-cluster does a couple of things, which is managed by Snakemake.

1. SNP VCF files are compressed and indexed (required for other analyses).
2. All indexed VCF files are merged into a multi-sample VCF.
3. A UPGMA tree is generated from the multi-sample VCF using vcfkit.
4. A Fasta pseudo-alignment is generated from the multi-sample VCF using vcfkit.
5. SNP distances are calculated from the pseudo-alignment using snp-dists.

A command line interface of the Snakemake pipeline has been generated using snk.

License

skiml-cluster is distributed under the terms of the MIT license.