/Functions Reference

This is a detailed reference for each analysis function in Celline. Each function has its own dedicated page with comprehensive documentation.

📚 Function Categories

🗄️ Data Management

  • Add - Add accession ID to your project
  • Download - Download data into your project
  • SyncDB - Database synchronization

🧮 Data Processing

🔬 Quality Control & Preprocessing

📊 Analysis & Visualization

🔧 Utilities

  • Info - System information display
  • Initialize - Project initialization
  • Interactive - Launch interactive web interface
  • Job - Job management
  • Bash - Execute bash commands

Quick Reference

CommandClassDescription
addAddAdd accession ID to your project
downloadDownloadDownload data into your project
syncdbSyncDBDatabase synchronization
countCountCount processing with Cell Ranger
createseuratobjectCreateSeuratObjectCreate Seurat objects
settranscriptomeSetTranscriptomeSet transcriptome reference
preprocessPreprocessQuality control and filtering
predict_celltypePredictCelltypeCell type prediction
buildcelltypemodelBuildCellTypeModelBuild cell type prediction model
reduceReduceDimensionality reduction
integrateIntegrateData integration
batchBatchCorrectionBatch effect correction
infoInfoSystem information display
initInitializeProject initialization
interactiveInteractiveLaunch interactive web interface
jobJobJob management
bashBashExecute bash commands

Usage Pattern

All functions follow the same pattern:

      from celline import Project
from celline.functions.module_name import ClassName

# Create project
project = Project("./my-project")

# Create function instance
function = ClassName(parameters)

# Execute function
result = project.call(function)

    

Click on any function name above to see detailed documentation with parameters, examples, and usage instructions.