Giter Club home page Giter Club logo

slicr's Introduction

SLICR

SLICR: Sparse Locally Involved Covariate Regression. A Python package for efficient, memory-conscious kNN distance correction, based on technical covariates whose effect should be removed.

Installation

TODO: upload to twine once we're happy with the algorithm

This is in alpha mode, so I haven't uploaded to PyPi yet! Just a placeholder You can install the package using pip: python3 -m pip install slicr

Usage

Here is a simple usage example:

import numpy as np
from scipy.sparse import csr_matrix
from slicr.analysis import slicr_analysis

# Create some dummy data
n = 1000  # number of nodes
g = 5  # number of covariates
k = 20  # number of nearest neighbors
dims = 50
obs_X = np.random.rand(n, dims)
obs_knn_dist = np.random.rand(n, k)
covar_mat = np.random.rand(n, g)

# Perform the analysis
results = slicr_analysis(obs_X, 
                   covar_mat, 
                   k, 
                   1)

But let's be real - this isn't trivial, so what about a non-trivial example:

TODO

Licensing

This software is available under dual-licencing. For non-commercial entities, this software can be used under the associated licence under the 'NON-COMMERCIAL-LICENSE' file. Commercial entities must enquire.

slicr's People

Contributors

scottyler89 avatar

Watchers

 avatar Kostas Georgiou 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.