Skip to content

Conversation

@oliverchampion
Copy link
Collaborator

add citation tag to code contributions

Describe the changes you have made in this PR

  • Add citation tags to wrapper
  • Add function to read out citation
  • Update a how-to-cite in readme.md

Link this PR to an issue [optional]

NA

Checklist

  • [ x ] Self-review of changed code
  • [ x ] Added automated tests where applicable
  • [ x ] Update Docs & Guides

add citation tag to code contributions
Copy link
Collaborator

@oscarjalnefjord oscarjalnefjord left a comment

Choose a reason for hiding this comment

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

I noticed an error in the csv file for my algorithms that has propagated to this PR. See the results on how to fix this.

README.md Outdated
The **utils** folder contains various helpful tools.

## Citing
If this repository was usefull, please cite our [upcoming MRM paper](https://eur04.safelinks.protection.outlook.com/?url=https%3A%2F%2Furldefense.com%2Fv3%2F__https%3A%2Fdrive.google.com%2Fdrive%2Fu%2F0%2Ffolders%2F1Yh7cHuBIDQ0fmlWum9banDFgCc6uf3XH__%3B!!K-Hz7m0Vt54!gNxtgp_trP5qT7uJBD7zz5-Wwi7y83_56-qBO2I2Zd9ATILK5_BWzAKmxSah9-y8N8Wsgy67pn1LMeCd9xfaQGM%24&data=05%7C02%7Co.j.gurney-champion%40amsterdamumc.nl%7Cceeee39962fc4098e61708de2e90699a%7C68dfab1a11bb4cc6beb528d756984fb6%7C0%7C0%7C638999394967163935%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=mu6wjTAM1DlCgZjfM3mkKZEuSm1vNiteCxdh5kV29WY%3D&reserved=0). The repository contains a lot of code from other sites. Please cite the appropriate papers depending on the code you used. The citations can be found with the "cite" function from OsipiBase:
Copy link
Collaborator

Choose a reason for hiding this comment

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

usefull->useful

id_algorithm_type = "Bi-exponential fit"
id_return_parameters = "f, D*, D, S0"
id_units = "seconds per milli metre squared or milliseconds per micro metre squared"
id_ref = "https://doi.org/10.1007/s10334-018-0697-5"
Copy link
Collaborator

Choose a reason for hiding this comment

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

There is an error in the csv file that has propagated to here. Three rows with my code contributions are correct in all columns except for the last two which have been swapped. For the last two columns (DOI and Wrapped) we need to change row 1->3, 2->1, 3->2

id_algorithm_type = "Bi-exponential fit"
id_return_parameters = "f, D*, D"
id_units = "seconds per milli metre squared or milliseconds per micro metre squared"
id_ref = "code specially written for this repository, based on the IVIM consensus paper (Eric Sigmund, Susi Rauh, et al. 2026) which will appear in jMRI"
Copy link
Collaborator

Choose a reason for hiding this comment

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

jMRI -> JMRI

return results

def cite(self):
print("thank you for using our repository. If it was usefull for your paper, please cite our upcoming paper in jMRI.")
Copy link
Collaborator

Choose a reason for hiding this comment

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

jMRI->MRM

README.md Outdated
If this repository was usefull, please cite our [upcoming MRM paper](https://eur04.safelinks.protection.outlook.com/?url=https%3A%2F%2Furldefense.com%2Fv3%2F__https%3A%2Fdrive.google.com%2Fdrive%2Fu%2F0%2Ffolders%2F1Yh7cHuBIDQ0fmlWum9banDFgCc6uf3XH__%3B!!K-Hz7m0Vt54!gNxtgp_trP5qT7uJBD7zz5-Wwi7y83_56-qBO2I2Zd9ATILK5_BWzAKmxSah9-y8N8Wsgy67pn1LMeCd9xfaQGM%24&data=05%7C02%7Co.j.gurney-champion%40amsterdamumc.nl%7Cceeee39962fc4098e61708de2e90699a%7C68dfab1a11bb4cc6beb528d756984fb6%7C0%7C0%7C638999394967163935%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=mu6wjTAM1DlCgZjfM3mkKZEuSm1vNiteCxdh5kV29WY%3D&reserved=0). The repository contains a lot of code from other sites. Please cite the appropriate papers depending on the code you used. The citations can be found with the "cite" function from OsipiBase:
```ruby
fit=osipibase(algorithm="IAR_LU_biexp")
fit.cite

Choose a reason for hiding this comment

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

Should be fit.cite() ?

return results

def cite(self):
print("thank you for using our repository. If it was usefull for your paper, please cite our upcoming paper in MRM.")

Choose a reason for hiding this comment

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

usefull -> useful here as well

Copy link
Collaborator

@oscarjalnefjord oscarjalnefjord left a comment

Choose a reason for hiding this comment

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

Looks good now

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.

4 participants