Science Environment for Ecological Knowledge
Ecoinformatics site parent site of Partnership for Biodiversity Informatics site parent site of SEEK - Home
Science Environment for Ecological Knowledge









 

 

 



Doc Writing

Difference between version 29 and version 28:

Lines 66-67 were replaced by line 66
-
- Notes
+ Notes from meeting
At line 76 added 26 lines.
+
+ Kirsten
+ *Create guidelines for how to write documentation for actors and Sam to place on Wiki
+ *Must note dependencies in the actor docs
+ **R actors need R installed
+ **GRASS actors need GRASS installed
+ **Matlab needs Matlab installed; command line actor depends on system-specific executables and is operating-system specific.
+ *''Web Service actor'': Update copy to reflect that the actor only works for a subset of WSDL constructs. Only ones that use base types for parameters or arrays of base types. “Intended to work on any web service with certain limitations, in particular related to the types of parameters that are used as input and output to Web Service.” Define “Web Service” in first paragraph e.g., “which is a… computer program that runs on a remote host using a standardized protocol.”
+ *''Random Normal actor'': this uses R norm and hist function—add note “For a full detailed desc. of how this actor works, look at R norm docs”
+ *''AddGrids actor'': Revise to say that actor takes “two or more geospatial images”/less jargon-y. Update desc. about file formats—it is not generically true that all actors use ESRI ASCII file format (e.g., not true for Interpolate actor)
+ *''EOL actors'' (“Encyclopedia of Life”) are not active any more and will likely be removed.
+ *''Boolean Multiplexor actor'': Revise to include context (used as a control flow actor/for branching) Suggested first sentence: “The Boolean Multiplexor uses a Boolean value to determine which of two input values to output.”
+ *Boolean Switch actor. Needs more context; only works under certain directors (SDF does not work; PN does work)
+ *''Expression actor'': Change to read “actor evaluates a specified expression”
+
+ Sam
+ *send email on ''VariableSetter''(developer to look at and clarify how this actor works)
+ *send email to Efrat to document*TransitiveClosureDatabaseQuery
+ *send email to Christopher to review Image Contrast actor documentation to clarify
+ *send email to Jianting to generalize actor and redocument ENM PCP actor without reference to niche model (PCP==Parallel Coordinates Plot).
+
+ Dan
+ *clarify Interpolator actor
+ *Directors (SDF, PN, etc) Need more of a functional description.
+
+ Notes from meeting

Back to Doc Writing, or to the Page History.