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.

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

initial joss draft #47

Merged
merged 2 commits into from
Dec 4, 2019
Merged

initial joss draft #47

merged 2 commits into from
Dec 4, 2019

Conversation

mgxd
Copy link
Member

@mgxd mgxd commented Nov 5, 2019

@codecov-io
Copy link

codecov-io commented Nov 5, 2019

Codecov Report

Merging #47 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #47   +/-   ##
=======================================
  Coverage   98.74%   98.74%           
=======================================
  Files          10       10           
  Lines         799      799           
  Branches      105      105           
=======================================
  Hits          789      789           
  Misses          6        6           
  Partials        4        4
Flag Coverage Δ
#unittests 98.74% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ed7e8ad...a1b1d64. Read the comment docs.

Copy link
Collaborator

@oesteban oesteban left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good! I would probably add the examples as they are pretty much explanatory.

joss/paper.md Outdated Show resolved Hide resolved
joss/paper.md Outdated Show resolved Hide resolved
joss/paper.md Outdated Show resolved Hide resolved
image $M$. These two operations are confusing because, while the spatial
transformation projects from $R$ to $M$, the data flows in reversed way after the
interpolation of the values of $M$ at the mapped coordinates $\vec{x}'$.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd add a section of examples, copying from the preprint.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

their docs explicitly state

software documentation such as API (Application Programming Interface) functionality should not be in the paper and instead should be outlined in the software documentation.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think an example or two cannot be considered software documentation, and they will very quickly convey what the tool does (ideally, I'm imagining two images on the left with some object signifying an input transform, they feed into the snippet and the output shows the moving image deformed via T). I can take a stab on this next week, don't worry about this.

Copy link
Collaborator

@oesteban oesteban left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's get this merged! I'll work on the figure ASAP.

@oesteban oesteban merged commit 76f525e into nipy:master Dec 4, 2019
@pull-assistant
Copy link

pull-assistant bot commented Dec 4, 2019

Score: 0.60

Best reviewed: commit by commit


Optimal code review plan (1 warning)

initial joss draft

joss/paper.md 58% changes removed in address comments fro...

     address comments from @oesteban review

Powered by Pull Assistant. Last update 2f717e0 ... a1b1d64. Read the comment docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants