Skip to content

matthewcarlucci/scikick

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Scikick - Notebook-Centric Analysis Workflows

PyPI pyversions Snakemake

Overview

Collections of computational notebooks often lose coherence as projects grow. Scikick is a command line utility for managing this growth with simple commands for workflow configuration, report generation, and state management.

Figure 1b from Carlucci M. et al, 2023.


Quick-Start

Scikick is currently tested on Unix systems (i.e. macOS, Linux etc.) and can be installed with:

pip install scikick

Initializing a Scikick project with sk init will create a scikick.yml file and identify any further missing software requirements.

Demonstrations and Documentation

Read the introduction for further details and installation requirements.

See the tutorial for a simple example usage of Scikick.

View a data analysis report generated by Scikick.

Use the issue board to provide feedback on Scikick (feature requests, bugs, and further software-related comments).

Citation

See further discussion about Scikick in the accompanying article:

Carlucci M, Bareikis T, Koncevičius K, Gibas P, Kriščiūnas A, Petronis A, et al. (2023) Scikick: A sidekick for workflow clarity and reproducibility during extensive data analysis. PLoS ONE 18(7): e0289171. https://doi.org/10.1371/journal.pone.0289171