Skip to content

Commit 42044b9

Browse files
authored
update citation tool documentation (#199)
1 parent 1da192b commit 42044b9

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

documentation/CP-plugins-documentation/citing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ If using CellProfiler Plugins in a pipeline used in a publication, please cite o
55
ENTER CITATION
66

77
Additionally, some plugins require citation themselves if used.
8-
You can determine which plugins require citation by reading the Help information for each plugin, accessible through CellProfiler, or by using the Citation generator built into CellProfiler (since VERSION).
8+
You can determine which plugins require citation by reading the Help information for each plugin, accessible through CellProfiler, or by using the Citation generator built into CellProfiler (since CellProfiler 5).
99

10-
To use CellProfiler's citation generator, load your pipeline into CellProfiler.
11-
Navigate to File => Export => Citation.
10+
![alt text](images/citation.png)
11+
Figure 1: How to use the citation tool. To use CellProfiler's citation generator, load your pipeline into CellProfiler (A). Navigate to File => Export => Citation (B). If any module in your pipeline is currently disabled, a citation for that module will still be generated but it will include a `disabled` tag.
1212

1313
Please note that many CellProfiler modules (including plugins) provide references that offer further information/background about the processing happening within the module.
1414
You may wish to read the references and cite any that upon which your analyses are particularly dependent.

documentation/CP-plugins-documentation/contributing_plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@ If you would like to update a currently deprecated plugin, we encourage you to r
2727

2828
## Having your plugin cited
2929

30-
While we cannot guarantee that users will cite your plugin, we have introduced a Citation generator into CellProfiler v? that scans all modules in a user's pipeline and generators a citation file for them that includes citation information for any modules (including plugins) that have specific citation information in them.
30+
While we cannot guarantee that users will cite your plugin, we have introduced a Citation generator into CellProfiler (currently available in CellProfiler from source and will be in CellProfiler 5) that scans all modules in a user's pipeline and generates a citation file for them that includes citation information for any modules (including plugins) that have specific citation information in them.
3131

3232
See [Citing Plugins](citing.md) for information on citing CellProfiler Plugins.
541 KB
Loading

0 commit comments

Comments
 (0)