|
From: Steve F. <sfi...@pc...> - 2005-06-01 23:36:08
|
folks-
as you might know, we at cbil are preparing for release 3.5. part of
that effort is to sort the plugins that exist into two categories:
- supported
- community
a supported plugin is one that is known to work, adheres to the plugin
standard, and will be of use to at least two sites. a community plugin
is not reviewed by CBIL. if it meets all three of those standards then
it would be promoted to supported.
we have designated a set of plugins that are supported (sent in previous
mail i believe).
and, we are now bringing them up to the standard.
part of the standard is how to name a plugin. we will be changing the
names of any supported plugins that do not comply.
here is the standard:
1. a plugin must start with one of four verbs:
- insert: insert only, no update or delete
- delete: delete only, no update or insert
- update: update only, no insert or delete
- load: any two or more of insert, delete or update
2. the name should be concise
3. the name should be accurate.
The poster child of a plugin name that needs improvement is
InsertNewExternalSequences. it violates all three rules. (in
fairness, it was written long ago before there were "standards" or even
users of GUS outside CBIL). the plugin inserts and updates, so it
should start with load. it is not concise because "insert" and "new" is
redundant. and, it is not accurate because (1) it can load sequences
that are already in the database (2) it can load sequences that are
generated internally as well as externally (the only constraint is that
it expects that the sequence be tagged with a source database) and (3)
it doesn't inform the user that it the sequences must be in Fasta format.
The new name will be LoadFastaSequences
(now isn't that clearer)
comments?
steve
|