Changes between Version 9 and Version 10 of TemporallyExtendedAttributes


Ignore:
Timestamp:
10/26/12 13:00:30 (7 years ago)
Author:
skyebend
Comment:

added return.tea prameter to spec for get methods

Legend:

Unmodified
Added
Removed
Modified
  • TemporallyExtendedAttributes

    v9 v10  
    101101The get.*.attribute.active methods function much like the corresponding conventional functions, but filter information in various ways based on the activity of the underlying attributes.  Usage is as follows: 
    102102    {{{ 
    103 get.edge.attribute.active(el, prefix, onset=NULL, terminus=NULL,length=NULL, at=NULL, rule = c("any", "all"), active.default = TRUE, dynamic.only=FALSE, require.active=FALSE) 
     103get.edge.attribute.active(el, prefix, onset=NULL, terminus=NULL,length=NULL, at=NULL, rule = c("any", "all"),  
     104                          active.default = TRUE, dynamic.only=FALSE, require.active=FALSE,return.tea=FALSE) 
    104105     
    105 get.edge.value.active(x, prefix, onset=NULL, terminus=NULL,length=NULL, at=NULL, rule = c("any", "all"), active.default = TRUE, dynamic.only=FALSE, require.active=FALSE) 
     106get.edge.value.active(x, prefix, onset=NULL, terminus=NULL,length=NULL, at=NULL, rule = c("any", "all"),  
     107                      active.default = TRUE, dynamic.only=FALSE, require.active=FALSE,return.tea=FALSE) 
    106108     
    107 get.network.attribute.active(x, prefix, onset=NULL, terminus=NULL,length=NULL, at=NULL, rule = c("any", "all"), active.default = TRUE, dynamic.only=FALSE, require.active=FALSE) 
     109get.network.attribute.active(x, prefix, onset=NULL, terminus=NULL,length=NULL, at=NULL, rule = c("any", "all"),  
     110                             active.default = TRUE, dynamic.only=FALSE, require.active=FALSE,return.tea=FALSE) 
    108111     
    109 get.vertex.attribute.active(x, prefix, onset=NULL, terminus=NULL,length=NULL, at=NULL, na.omit = FALSE, null.na = TRUE, rule = c("any", "all"), active.default = TRUE, dynamic.only=FALSE, require.active=FALSE) 
     112get.vertex.attribute.active(x, prefix, onset=NULL, terminus=NULL,length=NULL, at=NULL, na.omit = FALSE, null.na = TRUE,  
     113                           rule = c("any", "all"), active.default = TRUE, dynamic.only=FALSE, require.active=FALSE,return.tea=FALSE 
    110114    }}} 
    111 Behavior sketch: For the entities in question, seek a TEA with the indicated name prefix (failing over to regular attributes with attrname==prefix if dynamic.only=FALSE).  Given such a TEA, return the dynamic value information corresponding to the query interval (with all query parameters interpreted as per is.active).  By default, the activity of the underlying entity is ignored; if require.active==TRUE, attributes are considered inactive when the entity to which they are attached is inactive (w/active.default being used where necessary to impute activity).  Return values are in TEA form, specifically a list containing a value list along with a spell list.  
     115Behavior sketch: For the entities in question, seek a TEA with the indicated name prefix (failing over to regular attributes with attrname==prefix if dynamic.only=FALSE).  Given such a TEA, return the dynamic value information corresponding to the query interval (with all query parameters interpreted as per is.active).  By default, the activity of the underlying entity is ignored; if require.active==TRUE, attributes are considered inactive when the entity to which they are attached is inactive (w/active.default being used where necessary to impute activity).  If return.tea=TRUE values are in TEA form, specifically a list containing a value list along with a spell list. Otherwise return single matching value if one found, otherwise return earliest value and throw WARNING that multiple values match for the query spell.  
    112116 
    113117==== list.*.attribute.active ==== 
     
    130134 
    131135=== Questions === 
    132 Spec says get methods should return TEA value and spell list.  Skye thinks we should have a parameter "return.tea=FALSE" which would return this.  Otherwise return single matching value if one found, or the first (earliest) value matching query and throw Warning if multiple values match. I think this will cover the most common use cases better.  
     136Spec says get methods should return TEA value and spell list.  Skye thinks we should have a parameter "return.tea=FALSE" which would return this.  Otherwise return single matching value if one found, or the first (earliest) value matching query and throw Warning if multiple values match. I think this will cover the most common use cases better.  ADDED TO SPEC 
    133137 
     138Since spell structures forces non-overlapping, should we add an "earliest" and "latest" rule, and if it is set don't throw warning for multiple TEA match within query spell? 
    134139 
    135140Since these function names are getting very long, should we have short-hand versions? activate.vertex.attribute() : vAttrOn()