summarise_contribution: Summarise tracer contributions / suggest authorship for set...

In jefferis/elmr: Support for working with light and electron microscopy fly brain data

Summarise tracer contributions / suggest authorship for set of neurons

Description

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.

Usage

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) or a neuronlist
type	Whether to summarise contributions 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

## Not run: 
pnsc=summarise_contribution("annotation:^PN$")
suggest_authorship(pnsc)
write_authors(pnsc, auth=3.0)
write_ack(pnsc)

pnsc=summarise_contribution("annotation:^PN$", type='synapses')

## End(Not run)

jefferis/elmr documentation built on Sept. 9, 2023, 1:54 p.m.