{"id":30878544,"url":"https://github.com/unfoldtoolbox/unfoldride.jl","last_synced_at":"2026-02-13T12:23:33.451Z","repository":{"id":274758488,"uuid":"920067065","full_name":"unfoldtoolbox/UnfoldRIDE.jl","owner":"unfoldtoolbox","description":null,"archived":false,"fork":false,"pushed_at":"2025-09-02T10:46:40.000Z","size":138663,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-02T12:27:51.281Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Julia","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/unfoldtoolbox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-01-21T14:05:39.000Z","updated_at":"2025-09-02T10:45:34.000Z","dependencies_parsed_at":"2025-01-29T08:22:58.206Z","dependency_job_id":"928fb35e-10d6-4a8b-bb43-490cf3eb776c","html_url":"https://github.com/unfoldtoolbox/UnfoldRIDE.jl","commit_stats":null,"previous_names":["unfoldtoolbox/unfoldride.jl"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/unfoldtoolbox/UnfoldRIDE.jl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldtoolbox%2FUnfoldRIDE.jl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldtoolbox%2FUnfoldRIDE.jl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldtoolbox%2FUnfoldRIDE.jl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldtoolbox%2FUnfoldRIDE.jl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unfoldtoolbox","download_url":"https://codeload.github.com/unfoldtoolbox/UnfoldRIDE.jl/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldtoolbox%2FUnfoldRIDE.jl/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274135710,"owners_count":25228209,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-08T02:00:09.813Z","response_time":121,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-09-08T05:11:29.726Z","updated_at":"2026-02-13T12:23:33.439Z","avatar_url":"https://github.com/unfoldtoolbox.png","language":"Julia","funding_links":[],"categories":[],"sub_categories":[],"readme":"# UnfoldRIDE\n\n[![In development documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://unfoldtoolbox.github.io/UnfoldRIDE.jl/dev)\n[![Build Status](https://github.com/unfoldtoolbox/UnfoldRIDE.jl/workflows/Test/badge.svg)](https://github.com/unfoldtoolbox/UnfoldRIDE.jl/actions)\n[![Test workflow status](https://github.com/unfoldtoolbox/UnfoldRIDE.jl/actions/workflows/Test.yml/badge.svg?branch=main)](https://github.com/unfoldtoolbox/UnfoldRIDE.jl/actions/workflows/Test.yml?query=branch%3Amain)\n[![Lint workflow Status](https://github.com/unfoldtoolbox/UnfoldRIDE.jl/actions/workflows/Lint.yml/badge.svg?branch=main)](https://github.com/unfoldtoolbox/UnfoldRIDE.jl/actions/workflows/Lint.yml?query=branch%3Amain)\n[![Docs workflow Status](https://github.com/unfoldtoolbox/UnfoldRIDE.jl/actions/workflows/Docs.yml/badge.svg?branch=main)](https://github.com/unfoldtoolbox/UnfoldRIDE.jl/actions/workflows/Docs.yml?query=branch%3Amain)\n[![Coverage](https://codecov.io/gh/unfoldtoolbox/UnfoldRIDE.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/unfoldtoolbox/UnfoldRIDE.jl)\n\u003c!--[![DOI](https://zenodo.org/badge/DOI/FIXME)](https://doi.org/FIXME)--\u003e\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)\n[![All Contributors](https://img.shields.io/github/all-contributors/unfoldtoolbox/UnfoldRIDE.jl?labelColor=5e1ec7\u0026color=c0ffee\u0026style=flat-square)](#contributors)\n[![BestieTemplate](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/JuliaBesties/BestieTemplate.jl/main/docs/src/assets/badge.json)](https://github.com/JuliaBesties/BestieTemplate.jl)\n\nA re-implementation of the [RIDE](https://cns.hkbu.edu.hk/RIDE.htm) algorithm in Julia with an extension to replace the RIDEs iterative decomposition with an [Unfold](https://github.com/unfoldtoolbox/Unfold.jl) deconvolution.\n\n\u003e [!WARNING]\n\u003e This package is still in early development and should be seen as a beta version. While the algorithms seem to work in simulations we have seen some concerning results in real data applications.\n\u003e Use at your own risk. \n\n## Install\n\n### Installing Julia\n\n\u003cdetails\u003e\n\u003csummary\u003eClick to expand\u003c/summary\u003e\n\nThe recommended way to install julia is [juliaup](https://github.com/JuliaLang/juliaup).\nIt allows you to, e.g., easily update Julia at a later point, but also test out alpha/beta versions etc.\n\nTL:DR; If you dont want to read the explicit instructions, just copy the following command\n\n#### Windows\n\nAppStore -\u003e JuliaUp,  or `winget install julia -s msstore` in CMD\n\n#### Mac \u0026 Linux\n\n`curl -fsSL https://install.julialang.org | sh` in any shell\n\u003c/details\u003e\n\n### Installing UnfoldRIDE\n\n```julia\nusing Pkg\nPkg.add(\"UnfoldRIDE\")\n```\n\n## Quickstart\n\n```Julia\n#config for ride algorithm\ncfg = RideConfig(\n    #sfreq is the sampling frequency of the data\n    sfreq = 100,\n    #ranges for the individual components have to be determined through manual inspection of the data\n    s_range = [-0.1, 0.3],\n    r_range = [0, 0.4],\n    c_range = [-0.4, 0.4],\n    # formulas used for S, R, and C component (in this order!); if not specified these will default to `@formula(0~1)`\n    # Note that the interface will be more generalized in the near future\n    formulas = [@formula(0 ~ 1), @formula(0 ~ 1), @formula(0 ~ 1)] \n    #the range in which the initial peak estimation for the C component is performed\n    c_estimation_range = [0, 0.9],\n    #the range for one epoch\n    epoch_range = [-0.1, 1]\n)\n#run the ride algorithm\nresultsClassic = ride_algorithm(ClassicMode, data_noisy, evts_without_c, cfg)\nresultsUnfold = ride_algorithm(UnfoldMode, data_noisy, evts_without_c, cfg)\n```\n\n\u003e [!WARNING]\n\u003e In the 0.0.1 version of the package your events have to be coded as 'S' and 'R' chars in your events table.\n\n## How to Cite\n\nIf you use UnfoldRIDE.jl in your work, please cite using the reference given in [CITATION.cff](https://github.com/unfoldtoolbox/UnfoldRIDE.jl/blob/main/CITATION.cff).\n\n## Contributing\nContributions are very welcome. These could be typos, bugreports, feature-requests, speed-optimization, new solvers, better code, better documentation.\n\n### How-to Contribute\n\nYou are very welcome to raise issues and start pull requests!\n\n### Adding Documentation\n\n1. We recommend to write a Literate.jl document and place it in `docs/literate/FOLDER/FILENAME.jl` with `FOLDER` being `HowTo`, `Explanation`, `Tutorial` or `Reference` ([recommended reading on the 4 categories](https://documentation.divio.com/)).\n2. Literate.jl converts the `.jl` file to a `.md` automatically and places it in `docs/src/generated/FOLDER/FILENAME.md`.\n3. Edit [make.jl](https://github.com/unfoldtoolbox/UnfoldRIDE.jl/blob/main/docs/make.jl) with a reference to `docs/src/generated/FOLDER/FILENAME.md`.\n\n---\n\n### Contributors\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funfoldtoolbox%2Funfoldride.jl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funfoldtoolbox%2Funfoldride.jl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funfoldtoolbox%2Funfoldride.jl/lists"}