Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation update #184

Merged
merged 45 commits into from
Jan 17, 2024
Merged

Documentation update #184

merged 45 commits into from
Jan 17, 2024

Conversation

Horschig
Copy link
Contributor

@mayucel @jayd1860 This is the new PR for the documentation update. Please check if I did not mess up anything, and then please merge yourselves. We cannot do it, and it would be a shame if our effort would be wasted. Thanks!

Sofía Sappia and others added 30 commits October 27, 2021 11:59
Adjusts to argument validation syntax
679739c
Adjust argument validation, add input value checks
84b00f3
Fix a typo
198d5a0
@LiucijaSvink
Add input class and ppf argument validation functions
7cb2345
@LiucijaSvink
Add newline at the end of the file
8d0a0f1
@LiucijaSvink
Add input argument validation and revert last commit to cancel change…
575d744 
…s related to file storing
Adds verification of expected errors in argument validation
a6a6b01
Adds class verification test
94c0a6e
Adds nonNan and nonInf data input verification cheks
039aceb
Adds argument validation error tests
70a0da0
Add expected output check
39b6b57
Add expected output check
25f46b8
Add data class validation and corresponding test
790364f
Add expected output check
5fa3568
Add documentation for case when input is Hb data
6e5745d
Improves documentation. Adds note on delta_OD computation
feaca83
Improves documentation. Adds note on type of filter
acfe6af
Minor documentation improvement
1e902b6
Improves documentation.
e0402ef
@LiucijaSvink
Adjusted function and input description, added comments
028a821
@LiucijaSvink
Fix grammatical error.
4ef1e39
@LiucijaSvink
Improve documentation
4cd2cd7
@LiucijaSvink
Improve documentation, add explanation of p parameter
873c8e8
@LiucijaSvink
Explain mlActAuto input, adjust p parameter explanation and documenta…
f726eda 
…tion text alignment
@Horschig
Merge pull request #2 from Artinis-Medical-Systems-B-V/argument_valid…
4c74673 
…ation

Argument validation
Improves part of the documentation
0512858
Merge branch 'documentation' of https://github.com/Artinis-Medical-Sy…
0b484fc 
…stems-B-V/Homer3 into documentation
@LiucijaSvink
Minor documentation improvements
754b205
@LiucijaSvink
Merge commit '0b484fc83acf8ac69e6af335cf01b21d56c85117' into document…
d051039 
…ation
@LiucijaSvink
Adjust alignment and documentation
917d605
LiucijaSvink and others added 15 commits January 27, 2022 16:08
@LiucijaSvink
Add function and span descriptions
58777e0
@LiucijaSvink
Add function and span descriptions
8f16255
@LizaArtinis
doc - adding docs
103a5e9
@LiucijaSvink
Explain mlActAuto input
aa4f936
@LizaArtinis
doc - adding missing doc
479d1a1
@LiucijaSvink
Adjust description to match the function, adjust the format
d9a3ca3
@LiucijaSvink
Adjust description and output definition to match the function
3f04923
@LizaArtinis
Merge branch 'feature/adding_missing_docs' of https://github.com/Arti…
700086f 
…nis-Medical-Systems-B-V/Homer3 into documentation

# Conflicts:
#	FuncRegistry/UserFunctions/hmrG_SubjAvg.m
@LizaArtinis
enh - adding missing doc
60c4d58
@Horschig
deleting unit test from this branch
02b0166
@Horschig
deleting unit test from this branch
6f08157
@Horschig
deleting unit test from this branch
9c6d3f5
@Horschig
deleting unit test from this branch
f73a184
@Horschig
Merge remote-tracking branch 'upstream/development' into development
7d0b823
@Horschig
Merge branch 'development' into documentation_update
35a52a1 
# Conflicts:
#	FuncRegistry/UserFunctions/Archive/hmrS_SessAvgStd2_oldversion_nirs.m
#	FuncRegistry/UserFunctions/hmrG_SubjAvg.m
#	FuncRegistry/UserFunctions/hmrR_BlockAvg.m
#	FuncRegistry/UserFunctions/hmrR_MotionArtifact.m
#	FuncRegistry/UserFunctions/hmrR_MotionArtifactByChannel.m
#	FuncRegistry/UserFunctions/hmrR_MotionCorrectPCA.m
#	FuncRegistry/UserFunctions/hmrR_PCAFilter.m
#	FuncRegistry/UserFunctions/hmrS_SessAvgStd.m
@Horschig Horschig mentioned this pull request Sep 28, 2023
Closed
@Horschig Horschig mentioned this pull request Jan 17, 2024
Merged
@sreekanthkura7 sreekanthkura7 merged commit b112f4c into BUNPC:development Jan 17, 2024
@mayucel mayucel mentioned this pull request Jan 17, 2024
Merged
@mayucel
Copy link
Collaborator

mayucel commented Jan 18, 2024 •
edited
Loading

Hi Jorn @Horschig , thanks much for all this effort. I had to revert this commit as it caused issues in homer parsing of the "help string" (please check the link below for why). We would appreciate if you avoid making changes to the function help strings that can cause issues. Then we would be happy to merge it! Thanks again for all the effort!

Check out here: https://github.com/BUNPC/Homer3/wiki/User-Function-Definitions-and-the-Processing-Stream
"Defining a User Function"

@Horschig
Copy link
Contributor Author

Can you be more specific in what broke? I can imagine that it was something simple, like e.g. adding a line break in hmrR_BandpassFilt.m or the renaming PARAMETERS to DEFAULT PARAMETERS, or maybe that we added a line break. I would appreciate if you can be more specific in this or if you can tell me how I can find out what broke., because I would hate that the hours of work we spent into this go wasted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sreekanthkura7 sreekanthkura7 sreekanthkura7 approved these changes

@mayucel mayucel Awaiting requested review from mayucel

@jayd1860 jayd1860 Awaiting requested review from jayd1860

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Horschig @mayucel @sreekanthkura7 @LiucijaSvink @LizaArtinis