search

data2health / contributorship

Contributorship section for the authorship paper
https://data2health.github.io/contributorship/
Other
2 stars 2 forks source link

Revise and update Manubot section #11

Closed dhimmel closed 4 years ago

dhimmel commented 4 years ago

We have several comments in the text currently. I've copied them below along with my thoughts for each. Perhaps we could identify a few of the points that are most essential and I could address them as part of this pull request? CC @jcolomb and @nicolevasilevsky

Add something here about using CRO? Manubot should be be able to track our contributions in the yaml file too? JC: I am not sure that it actually works, github functionality is only counting commits number, not importance, and manubot would only track work done during manuscript writing. To get something automated we would need something much more complicated, where (for example) data would be published with a list of contributor, that list being imported into the manuscript while linking the manuscript to the data.

We have now enabled the contributor roles from the metadata.yaml file to appear in the HTML manuscript. We could add a small figure to the manuscript showing this if we think that's valuable?

Currently, we are not assigning contributor roles by looking at who did what. That would be really cool, but a much larger undertaking.

Can it be imported into author submission systems too, so we don't have to fill out the authorship sections in journals? That would be amazing!

Not yet, but hopefully someday. Perhaps I should note this as a good future direction?

JC: very little portability of the yaml actually, not even to other system using yaml to enter author information. One would need a codec to translate the list from one format to another, see github.com/open-science-promoters/contibutor_manager

Should we mention this as well as our preliminary efforts to create a standard schema?

putting citation just with doi has also its disadvantage, I do prefer a solution using a bib file (produced by a reference manager) and an author-date call to the bib file, otherwise one always need to click to see what the publication actually is

Manubot supports citations tags like:

the ability to illuminate and eliminate gender disparities in research roles (see @tag:Macaluso-2016).

[@tag:Macaluso-2016]: doi:10.1097/ACM.0000000000001261

Some features that would be nice to see in Manubot: [NV: not sure if these already exist? @dhimmel]

  • A way to tag other users. In google docs, you can +email someone, and they will get an email that you mentioned them in a comment, and can assign them tasks in the doc

Tagging users with their GitHub handle is how we accomplish this. So all notifications are really handled through GitHub.

  • is there spell check integrated somewhere?

No but it's a requested feature in https://github.com/manubot/manubot/issues/31.

can the yaml file with author metadata be converted to a spreadsheet, for easier viewing? Can the authors be reordered/alphabetized?

Yes quite easily with the right commands, but knowing those commands takes some technical expertise.

dhimmel commented 4 years ago

I'll merge this now and we can address the comments above in a subsequent change.

agitter commented 4 years ago

is there spell check integrated somewhere?

Manubot now has basic spellcheck capabilities introduced in https://github.com/manubot/rootstock/pull/333. I'd be happy to help set it up or explain the usage if there is still interest.