Data

Tools

Indexes

Applications

Experiments

Open Source Science

unfoldride.jl

https://github.com/unfoldtoolbox/unfoldride.jl

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.4%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: unfoldtoolbox
  • License: mit
  • Language: Julia
  • Default Branch: main
  • Size: 132 MB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created about 1 year ago · Last pushed 7 months ago
Metadata Files
Readme License Code of conduct Citation

README.md

UnfoldRIDE

In development documentation Build Status Test workflow status Lint workflow Status Docs workflow Status Coverage <!--DOI--> Contributor Covenant All Contributors BestieTemplate

A re-implementation of the RIDE algorithm in Julia with an extension to replace the RIDEs iterative decomposition with an Unfold deconvolution.

Install

Installing Julia

Click to expand The recommended way to install julia is [juliaup](https://github.com/JuliaLang/juliaup). It allows you to, e.g., easily update Julia at a later point, but also test out alpha/beta versions etc. TL:DR; If you dont want to read the explicit instructions, just copy the following command #### Windows AppStore -> JuliaUp, or `winget install julia -s msstore` in CMD #### Mac & Linux `curl -fsSL https://install.julialang.org | sh` in any shell

Installing UnfoldRIDE

julia using Pkg Pkg.add("UnfoldRIDE")

Quickstart

```Julia

config for ride algorithm

cfg = RideConfig( #sfreq is the sampling frequency of the data sfreq = 100, #ranges for the individual components have to be determined through manual inspection of the data srange = [-0.1, 0.3], rrange = [0, 0.4], crange = [-0.4, 0.4], #the range in which the initial peak estimation for the C component is performed cestimationrange = [0, 0.9], #the range for one epoch epochrange = [-0.1, 1] )

run the ride algorithm

resultsClassic = ridealgorithm(ClassicMode, datanoisy, evtswithoutc, cfg) resultsUnfold = ridealgorithm(UnfoldMode, datanoisy, evtswithoutc, cfg) ```

How to Cite

If you use UnfoldRIDE.jl in your work, please cite using the reference given in CITATION.cff.

Contributing

Contributions are very welcome. These could be typos, bugreports, feature-requests, speed-optimization, new solvers, better code, better documentation.

How-to Contribute

You are very welcome to raise issues and start pull requests!

Adding Documentation

  1. 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).
  2. Literate.jl converts the .jl file to a .md automatically and places it in docs/src/generated/FOLDER/FILENAME.md.
  3. Edit make.jl with a reference to docs/src/generated/FOLDER/FILENAME.md.

Contributors

Owner

  • Name: unfoldtoolbox
  • Login: unfoldtoolbox
  • Kind: organization
  • Email: info@unfoldtoolbox.org

Unfold your potentials...

Citation (CITATION.cff) 

cff-version: 1.2.0
title: UnfoldRIDE.jl
message: 'If you use this page, please cite it as below.'
type: software
authors:
  - given-names: Benedikt
    family-names: Ehinger
    orcid: 'https://orcid.org/0000-0002-6276-3332'
  - given-names: Till
    family-names: Prölß
  - given-names: René
    family-names: Skukies
    orcid: 'https://orcid.org/0000-0002-4124-4584'

repository-code: 'https://github.com/unfoldtoolbox/UnfoldRIDE.jl'

GitHub Events

Total
  • Release event: 1
  • Delete event: 5
  • Issue comment event: 1
  • Member event: 2
  • Push event: 45
  • Pull request review event: 17
  • Pull request review comment event: 20
  • Pull request event: 16
  • Create event: 13
Last Year
  • Release event: 1
  • Delete event: 5
  • Issue comment event: 1
  • Member event: 2
  • Push event: 45
  • Pull request review event: 17
  • Pull request review comment event: 20
  • Pull request event: 16
  • Create event: 13

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 0
  • Total pull requests: 12
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 months
  • Total issue authors: 0
  • Total pull request authors: 3
  • Average comments per issue: 0
  • Average comments per pull request: 0.08
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 10
Past Year
  • Issues: 0
  • Pull requests: 12
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 months
  • Issue authors: 0
  • Pull request authors: 3
  • Average comments per issue: 0
  • Average comments per pull request: 0.08
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 10
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • github-actions[bot] (8)
  • Till223 (2)
  • dependabot[bot] (2)
Top Labels
Issue Labels
Pull Request Labels
dependencies (2) chore (2) github_actions (1)

Dependencies

.github/workflows/CompatHelper.yml actions
  • julia-actions/cache v2 composite
  • julia-actions/setup-julia v2 composite
.github/workflows/Docs.yml actions
  • actions/checkout v4 composite
  • julia-actions/cache v2 composite
  • julia-actions/setup-julia v2 composite
.github/workflows/Lint.yml actions
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • julia-actions/cache v2 composite
  • julia-actions/setup-julia v2 composite
  • lycheeverse/lychee-action v2 composite
.github/workflows/PreCommitUpdate.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • peter-evans/create-pull-request v7 composite
.github/workflows/ReusableTest.yml actions
  • actions/checkout v4 composite
  • codecov/codecov-action v4 composite
  • julia-actions/cache v2 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/julia-processcoverage v1 composite
  • julia-actions/julia-runtest v1 composite
  • julia-actions/setup-julia v2 composite
.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite
.github/workflows/Test.yml actions
.github/workflows/TestOnPRs.yml actions