GithubHelp home page GithubHelp logo

jtfouquier / explana Goto Github PK

View Code? Open in Web Editor NEW
2.0 2.0 0.0 3.91 MB

Workflow to generate interactive html feature selection report for longitudinal and cross-sectional microbiome studies

Python 48.90% R 51.10%
classification exploratory-data-analysis feature-selection hypothesis-generation importance machine-learning microbiome random-forest regression

explana's Introduction

Copyright 2023-2024 Regents of the University of Colorado. All rights reserved.

Authored by Jennifer Therese Fouquier

Free for academic use. For other licensing information and user guide can be found at explana.io

Please contact me with any issues, suggestions or questions at [email protected]

EXPLANA: A user-friendly workflow for EXPLoratory ANAlysis and feature selection in longitudinal and cross-sectional microbiome studies

EXPLANA was developed to streamline identification of important features that relate to response variables in longitudinal, and cross-sectional, microbiome studies.

Response variables can be numerical or binary categorical and input features can be numerical or categorical. If order of categorical value changes impacts a response, this will be identified.

Features are ranked by their importance, and feature impact on response is additinoally provided. An interactive .html report is generated for each analysis that visually and textually summarizes results.

This is an exploratory method and this should be made clear when communicating results.

Install

Source code

Run the command:

git clone [email protected]:JTFouquier/explana.git

Next, navigate to directory with Snakefile and work from there.


Create Conda environment using Mamba

You must be inside the directory with Snakefile to create the explana environment and run your analyses.

You will need to install Mambaforge (download Mambaforge here)

mamba env create -f conda_envs/environment.yaml -n explana

Activate the explana conda environment. This is needed to ensure specific software versions are used.

conda activate explana


Test install

Run EXPLANA with small install demo. If possible, use more cores (I use 6).

snakemake --configfile config/config-install-test.yaml --cores 2 --use-conda

Open html report (or double click it from within directory)

open workflow-results/EXPLANA-install-test/EXPLANA-report.html

To retest, remove output folder.

To remove and retest (rm -r removes a folder and cannot be undone):

rm -r workflow-results/EXPLANA-install-test/

If workflow partially runs, rerun snakemake command and Snakemake will resume analysis.


FAQs and user manual coming soon

Useful Reading

explana's People

Contributors

jtfouquier avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.