Clarify Table 1 and hyperlink documentation references - #204
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two reader-facing clarity fixes on paper.md.
Table 1 was unreadable
The "Result (mean)" column packed two metrics on two datasets into cryptic delimited cells: "0.998 / 0.006" (the reader can't tell 0.998 is Hungarian-matched correlation and 0.006 is Amari distance), and$k$ ; the caption now explains that the correlation headline uses the well-determined external recording ($k\approx153$ ) while the Amari/score-function checks use the bundled sample ($k\approx30$ ). No more "/" decoding or unexplained $k$ . (Also removed the text/caption duplication of the $k$ definition.)
$k$jumped between 153 and 30 with no explanation (they are two different recordings). Restructured so each metric gets its own row, is named, and states its dataset andBare "(documentation)" not hyperlinked
The four "(documentation)" references were plain text (or only the raw URL was linked). All four now hyperlink the word to the validation guide (https://eeglab.org/pAMICA/guides/validation/).
Body 1570 words, no em-dashes; Draft PDF CI validates the build.