You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -12,13 +12,13 @@ The sections below outline the steps in each case.
12
12
13
13
## You have a question
14
14
15
-
1. use the search functionality [here](https://github.com/resurfemg/resurfemg/issues) to see if someone already filed the same issue;
15
+
1. use the search functionality [here](https://github.com/resurfemg-org/ReSurfEMG/issues) to see if someone already filed the same issue;
16
16
1. in some cases checking the documentation may help but if your issue search did not yield any relevant results, make a new issue;
17
17
1. apply the "Question" label; apply other labels when relevant.
18
18
19
19
## You think you may have found a bug
20
20
21
-
1. use the search functionality [here](https://github.com/resurfemg/resurfemg/issues) to see if someone already filed the same issue;
21
+
1. use the search functionality [here](https://github.com/resurfemg-org/ReSurfEMG/issues) to see if someone already filed the same issue;
22
22
1. if your issue search did not yield any relevant results, make a new issue, making sure to provide enough information to the rest of the community to understand the cause and context of the problem. Depending on the issue, you may want to include:
23
23
- the [SHA hashcode](https://help.github.com/articles/autolinked-references-and-urls/#commit-shas) of the commit that is causing your problem;
24
24
- some identifying information (name and version number) for dependencies you're using;
of respiratory electromyography (EMG). On the same site as
16
16
the repository for this library we keep [related resources](https://github.com/ReSurfEMG?tab=repositories).
17
17
18
-
ReSurfEMG includes a [main code library](https://github.com/ReSurfEMG/ReSurfEMG) where the user can access the code to change various filter and analysis settings directly and/or in our [researcher interface notebooks](https://github.com/ReSurfEMG/ReSurfEMG/tree/main/notebooks/researcher_interface).
19
-
In addition, ReSurfEMG has a [dashboard interface](https://github.com/ReSurfEMG/ReSurfEMG-dashboard) which contains default settings for preprocessing and analysis which can be changed through a graphical (no code) interface. We have some functionality available through a [command line interface](#command-line-interface) as well.
18
+
ReSurfEMG includes a [main code library](https://github.com/resurfemg-org/ReSurfEMG) where the user can access the code to change various filter and analysis settings directly and/or in our [researcher interface notebooks](https://github.com/resurfemg-org/ReSurfEMG/tree/main/notebooks/researcher_interface).
19
+
In addition, ReSurfEMG has a [dashboard interface](https://github.com/resurfemg-org/ReSurfEMG-dashboard) which contains default settings for preprocessing and analysis which can be changed through a graphical (no code) interface. We have some functionality available through a [command line interface](#command-line-interface) as well.
20
20
21
21
The library was initially built for surface EMG, however many functions will also work for
22
22
invasively measured respiratory EMG. This library supports the ongoing research at University of Twente on respiratory EMG.
23
23
24
24
25
25
### Program files
26
26
27
-
The core functions of ReSurfEMG are in the folder [resurfemg](https://github.com/ReSurfEMG/ReSurfEMG/tree/main/resurfemg):
27
+
The core functions of ReSurfEMG are in the folder [resurfemg](https://github.com/resurfemg-org/ReSurfEMG/tree/main/resurfemg):
28
28
29
29
-**cli:** Scripts for the command line interface
30
30
-**data_connector:** Converter functions for discovering, loading, simulating and handling data.
@@ -42,7 +42,7 @@ The core functions of ReSurfEMG are in the folder [resurfemg](https://github.com
42
42
43
43
### Folders and Notebooks
44
44
45
-
Our [guide to notebooks](https://github.com/ReSurfEMG/ReSurfEMG/blob/main/notebooks_guide.md) is under construction. To look around keep in mind the following distinction on folders:
45
+
Our [guide to notebooks](https://github.com/resurfemg-org/ReSurfEMG/blob/main/notebooks_guide.md) is under construction. To look around keep in mind the following distinction on folders:
46
46
47
47
dev:
48
48
- These notebooks are used in feature development and debugging by core members of the ReSurfEMG team. They can provide a basic example how to use some of the functionality.
@@ -62,7 +62,7 @@ Dr. Eline Mos-Oppersma( 📫 [email protected]) to discuss any
62
62
questions on data configuration for your datasets.
63
63
64
64
If you want to use a standardized dataset for any purpose we recommend
65
-
the data in the [ReSurfEMG/test_data](https://github.com/ReSurfEMG/ReSurfEMG/blob/main/test_data), which is also used in testing the ReSurfEMG functions.
65
+
the data in the [ReSurfEMG/test_data](https://github.com/resurfemg-org/ReSurfEMG/blob/main/test_data), which is also used in testing the ReSurfEMG functions.
66
66
Data there can be used with any respiratory EMG algorithms in any program. Thus that data can function as a benchmarking set to compare algorithms across different programs.
67
67
68
68
Alternatively, the data in the ReSurfEMG/synthetic_data repository:
@@ -172,7 +172,7 @@ pip install resurfemg[dev]
172
172
command in your terminal. This opens a browser window where you can browse,
173
173
open and run the notebooks. (We use [Jupyter notebooks](https://jupyter.org/try-jupyter/retro/notebooks/?path=notebooks/Intro.ipynb))
174
174
The ReSurfEMG notebooks are located in the notebooks folder. Navigate there
175
-
and open a notebook of interest. The [basic_emg_analysis](https://github.com/ReSurfEMG/ReSurfEMG/blob/main/researcher_interface/basic_emg_analysis.ipynb)
175
+
and open a notebook of interest. The [basic_emg_analysis](https://github.com/resurfemg-org/ReSurfEMG/blob/main/researcher_interface/basic_emg_analysis.ipynb)
176
176
notebook can be used to understand how to use the package.
177
177
178
178
@@ -257,7 +257,7 @@ The project has a sub-project of a related dashboard. Dashboard is a GUI that
257
257
exposes some of the project's functionality. In the past, we kept a a legacy
258
258
dashboard in the same repository with ReSurfEMG code but we have deleted it.
259
259
The current version of the dashboard into it's own repository:
0 commit comments