summarise_contribution produces a data.frame of contributions by user. suggest_authorship can use this to suggest which contributors meet defined authorship/acknowledgement criteria.

suggest_authorship suggests how to acknowledge individuals

write_authors produces a list of authors

write_ack produces an acknowledgements wording.

summarise_contribution(skids, type = c("nodes", "synapses", "pre", "post"),
  ...)

suggest_authorship(x, auth = 5, ackn = c(3000, 100))

write_authors(x, ...)

write_ack(x, ...)

Arguments

skids
catmaid skeleton ids (see catmaid_skids)
type
Whether to summarise contributinons towards arbour (nodes) or synapses
...
Additional arguments passed by summarise_contribution to catmaid_get_contributor_stats or by write_authors/write_ack to suggest_authorship
x
A data frame containing the output of summarise_contribution
auth
The minimum percentage of the total effort for authorship
ackn
The minimum number of nodes/synapses to be acknowledged. When length of 2, the first number is assumed to be the criterion for arbour nodes, the second for synapses.

Value

A data.frame describing contributions or for write_authors/write_ack a string describing in descending order of contribution written to the console by cat.

Examples

pnsc=summarise_contribution("annotation:^PN$") suggest_authorship(pnsc)
#> id n full_name pct cpct action #> 1 12 110422 Jacob Ratliff 15.8169156 15.81692 auth #> 2 11 80683 bailey harrison 11.5570828 27.37400 auth #> 3 26 70244 Jawaid Ali 10.0617940 37.43579 auth #> 4 13 63207 Addy Adesina 9.0538098 46.48960 auth #> 5 54 42307 Ben Koppenhaver 6.0600808 52.54968 auth #> 6 25 39588 Lucia Kmecova 5.6706096 58.22029 auth #> 7 53 37882 Najla Masoodpanah 5.4262411 63.64653 auth #> 8 4 34347 Corey Fisher 4.9198855 68.56642 ack #> 9 61 31114 Benjamin Gorko 4.4567886 73.02321 ack #> 10 17 28372 Adam John 4.0640228 77.08723 ack #> 11 117 26017 Ruairi Roberts 3.7266912 80.81392 ack #> 12 22 21093 Michael Lingelbach 3.0213744 83.83530 ack #> 13 50 18605 Shahrozia Imtiaz 2.6649917 86.50029 ack #> 14 29 15715 Nadiya Sharifi 2.2510263 88.75131 ack #> 15 75 14830 Philipp Ranft 2.1242584 90.87557 ack #> 16 55 9282 Greg Jefferis 1.3295594 92.20513 ack #> 17 27 7848 Sri Murthy 1.1241524 93.32928 ack #> 18 120 4888 Amelia Edmondson-Stait 0.7001601 94.02944 ack #> 19 118 4260 Clement Hallou 0.6102050 94.63965 ack #> 20 94 4042 Philipp Schlegel 0.5789786 95.21863 ack #> 21 28 3769 Bindu Gampah 0.5398739 95.75850 ack #> 22 123 3137 Fiona Love 0.4493458 96.20785 ack #> 23 76 3052 Steven Calle 0.4371704 96.64502 ack #> 24 2 3039 Davi Bock 0.4353082 97.08033 ack
write_authors(pnsc, auth=3.0)
#> Jacob Ratliff, bailey harrison, Jawaid Ali, Addy Adesina, Ben Koppenhaver, Lucia Kmecova, Najla Masoodpanah, Corey Fisher, Benjamin Gorko, Adam John, Ruairi Roberts, Michael Lingelbach
write_ack(pnsc)
#> We thank Corey Fisher, Benjamin Gorko, Adam John, Ruairi Roberts, Michael Lingelbach, Shahrozia Imtiaz, Nadiya Sharifi, Philipp Ranft, Greg Jefferis, Sri Murthy, Amelia Edmondson-Stait, Clement Hallou, Philipp Schlegel, Bindu Gampah, Fiona Love, Steven Calle, Davi Bock for contributing 33.4 % of reconstructed arbour cable.
pnsc=summarise_contribution("annotation:^PN$", type='synapses')