Skip to content
Joanna Pylvänäinen edited this page May 29, 2024 · 34 revisions

CellTracksColab Wiki


Welcome to CellTracksColab, your comprehensive platform for analyzing cell migration tracks. Whether you're a beginner or an experienced researcher, our platform offers intuitive guidance every step of the way. You'll find detailed explanations in the notebooks to help you navigate the analysis process. Plus, a test dataset is provided to get you started immediately.

📹 Video Tutorials

CellTracksColab in Goolgle drive

Tutorial 1: Getting Started with CellTracksColab using Google Colab

CellTracksColab in Jupyter lab

Tutorial 2: Using CellTracksColab locally using Jupyter

CellTracksColab in locally with Google Colab

Tutorial 3: Using CellTracksColab locally using Google Colab

🛠️ Quick Start

1. Check and Organize Your Data

CellTracksColab has been tested with tracking outputs from:

TrackMate Logo CellProfiler Logo Icy Logo ilastik Logo Fiji Logo
TrackMate CellProfiler Icy ilastik Fiji Manual Tracker

But may also be compatible with other tracking software exporting tracking results that meet our minimal requirements. Ensure your data is well-organized according to the recommended folder hierarchy. This structure helps in managing and analyzing the data efficiently.

2. Choose Where to Run CellTracksColab

The easiest way to start using CellTracksColab is in the cloud using Google Collaboratory, but it can also be used on your own computer using Jupyter Notebooks.

3. Load and Plot Your Data

We provide three notebooks for loading and analyzing your data depending on its format:

Notebook Purpose Required File Format Link
CellTracksColab - TrackMate Load and analyze TrackMate data. More info on how to prepare the data here. CSV or XML files Open In Colab
CellTracksColab - Custom Analyze data from CellProfiler, ICY, ilastik, or Fiji Manual Tracker. More info on how to prepare the data here. CSV files Open In Colab
CellTracksColab - Viewer Load and share data in the CellTracksColab format. CellTracksColab format Open In Colab

4. Advanced Analysis Modules

These notebooks require your dataset to be in the CellTracksColab format.

Notebook Purpose Required File Format Link
CellTracksColab - Dimensionality Reduction Utilize advanced dimensionality reduction techniques. CellTracksColab format Open In Colab
CellTracksColab - Track Spatial Clustering Analysis Dive deeper into your dataset with track clustering analysis. CellTracksColab format Open In Colab
CellTracksColab - Distance to ROI Analyze movement tracks in relation to designated ROIs. CellTracksColab format Open In Colab

More to come

Other Notebooks

CellTracksColab - TrackMate - Plate:

  • Handle TrackMate CSV files structured in a plate format, such as file names commonly produced by incubator microscopes like Incucytes.
  • Open In Colab

📦 Resources


✍️ Contributors


🤝 Contribute

We welcome your insights and improvements! There are several ways you can contribute to the CellTracksColab project:

Issues

If you encounter any bugs, have suggestions for improvements, or want to discuss new features, please raise an issue on our GitHub Issues page.

New Analysis Notebooks

We are excited to see new analysis notebooks built on the CellTracksColab platform. If you have developed a new notebook, please submit it via a pull request. All submitted notebooks should include a test dataset to showcase their functionality. Each notebook will be tested by a member of the team before being released.

Code of Conduct

We expect all contributors to adhere to our simple code of conduct:

  • Be respectful and considerate of others.
  • Provide constructive feedback.
  • Collaborate openly and honestly.

By participating in this project, you agree to abide by these guidelines.


Thank you for contributing to CellTracksColab! Your support and contributions help us improve and expand the platform for everyone in the community.


License

Licensed under the MIT License. Details here.


📜 Citation

If you use CellTracksColab in your research, please cite the following paper:

Reference

Guillaume Jacquemet. (2023). CellTracksColab—A platform for compiling, analyzing, and exploring tracking data. bioRxiv. https://doi.org/10.1101/2023.10.20.563252

Download PDF

Clone this wiki locally