Final set of edits for descriptions, refs #237

outcomesinsights · May 2, 2023 · 2781d66 · 2781d66
1 parent b4a9ddc
commit 2781d66
Show file tree

Hide file tree

Showing 16 changed files with 20 additions and 20 deletions.
diff --git a/lib/conceptql/operators/after.rb b/lib/conceptql/operators/after.rb
@@ -5,7 +5,7 @@ module Operators
     class After < TemporalOperator
       register __FILE__
 
-      desc "Compares records on a person-by-person basis, passes along left hand records with a start_date that occurs after the earliest end_date of a right hand record."
+      desc "For each person, passes along left hand records with a start_date that occurs after the earliest end_date of a right hand record."
 
       allows_at_least_option
       within_skip :after

diff --git a/lib/conceptql/operators/any_overlap.rb b/lib/conceptql/operators/any_overlap.rb
@@ -5,7 +5,7 @@ module Operators
     class AnyOverlap < TemporalOperator
       register __FILE__
 
-      desc "Compares records on a person-by-person basis and passes along left hand records with a date range that overlaps in any way with a right hand record's date_range."
+      desc "For each person, passes along left hand records with a date range that overlaps in any way with a right hand record's date_range."
 
       def where_clause
         ((within_start <= l_start_date) & (l_start_date <= within_end)) | ((l_start_date <= within_start) & (within_start <= l_end_date))

diff --git a/lib/conceptql/operators/before.rb b/lib/conceptql/operators/before.rb
@@ -5,7 +5,7 @@ module Operators
     class Before < TemporalOperator
       register __FILE__
 
-      desc "Compares records on a person-by-person basis, passes along left hand records with an end_date that occurs before the most recent start_date of a right hand record."
+      desc "For each person, passes along left hand records with an end_date that occurs before the most recent start_date of a right hand record."
 
       allows_at_least_option
       within_skip :before

diff --git a/lib/conceptql/operators/co_reported.rb b/lib/conceptql/operators/co_reported.rb
@@ -6,7 +6,8 @@ module Operators
     class CoReported < PassThru
       register __FILE__
 
-      desc 'Passes along all events that were co-reported in a database. For GDM, an event is considered to be "co-reported" if it shares the same context_id as another event.'
+      desc "Passes along all events that were co-reported in the same record in the source data."
+
       allows_many_upstreams
       category "Combine Streams"
       default_query_columns

diff --git a/lib/conceptql/operators/contains.rb b/lib/conceptql/operators/contains.rb
@@ -5,7 +5,7 @@ module Operators
     class Contains < TemporalOperator
       register __FILE__
 
-      desc "Compares records on a person-by-person basis and passes along left hand records with a start_date and end_date contained within a right hand record's start_date and end_date."
+      desc "For each person, passes along left hand records with a start_date and end_date containing a right hand record's start_date and end_date."
 
       def where_clause
         (within_start <= r_start_date) & (r_end_date <= within_end)

diff --git a/lib/conceptql/operators/during.rb b/lib/conceptql/operators/during.rb
@@ -5,7 +5,7 @@ module Operators
     class During < TemporalOperator
       register __FILE__
 
-      desc "Compares records on a person-by-person basis and passes along left hand records with a start_date within a right hand record's start_date and end_date."
+      desc "For each person, passes along left hand records with a start_date and end_date within a right hand record's start_date and end_date."
 
       def where_clause
         (within_start <= l_start_date) & (l_end_date <= within_end)

diff --git a/lib/conceptql/operators/equal.rb b/lib/conceptql/operators/equal.rb
@@ -5,7 +5,8 @@ module Operators
     class Equal < TemporalOperator
       register __FILE__
 
-      desc 'Compares records on a person-by-person basis and passes along left hand records that have the same value_as_number as a right hand record.'
+      desc 'For each person, passes along left hand records that have the same value_as_number as a right hand record.'
+
       require_column :value_as_number
 
       def where_clause

diff --git a/lib/conceptql/operators/first.rb b/lib/conceptql/operators/first.rb
@@ -17,7 +17,7 @@ module Operators
     class First < Occurrence
       register __FILE__
 
-      desc "Passes along, per person, the record with the earliest start_date."
+      desc "For each person, passes along the record with the earliest start_date."
 
       def occurrence
         1

diff --git a/lib/conceptql/operators/last.rb b/lib/conceptql/operators/last.rb
@@ -17,7 +17,7 @@ module Operators
     class Last < Occurrence
       register __FILE__
 
-      desc "Passes along, per person, the record with the most recent start_date."
+      desc "For each person, passes along the record with the most recent start_date."
 
       def occurrence
         -1

diff --git a/lib/conceptql/operators/numeric_filter.rb b/lib/conceptql/operators/numeric_filter.rb
@@ -11,7 +11,7 @@ module Operators
     class NumericFilter < Operator
       register __FILE__
 
-      desc 'Includes records with a value_as_number that matches the given criteria.  Excludes records where value_as_number is NULL.'
+      desc "Includes records with a value_as_number that match the given criteria."
 
       option :greater_than_or_equal_to, type: :float
       option :less_than_or_equal_to, type: :float

diff --git a/lib/conceptql/operators/one_in_two_out.rb b/lib/conceptql/operators/one_in_two_out.rb
@@ -7,11 +7,8 @@ module Operators
     class OneInTwoOut < Operator
       register __FILE__
 
-      desc <<-EOF
-Applies a common pattern in research algorithms by searching for an event
-that appears either once in an inpatient setting or
-twice in an outpatient setting with a specified gap.
-      EOF
+      desc 'Identifies an event that appears either once in an inpatient setting or twice within a specified interval in an outpatient setting.'
+
       allows_one_upstream
       validate_one_upstream
       validate_no_arguments

diff --git a/lib/conceptql/operators/person.rb b/lib/conceptql/operators/person.rb
@@ -8,7 +8,8 @@ class Person < CastingOperator
 
       register __FILE__
 
-      desc "Selects all person records."
+      desc "Selects all records in the person table."
+
       allows_one_upstream
       domains :person
 

diff --git a/lib/conceptql/operators/provenance.rb b/lib/conceptql/operators/provenance.rb
@@ -16,7 +16,7 @@ module Operators
     class Provenance < Operator
       register __FILE__
 
-      desc "Passes along records with the indicated provenance."
+      desc "Passes along records with the indicated provenance (e.g. inpatient, outpatient, file type)."
 
       argument :provenance_types, label: 'Provenance Types', type: :codelist
       category "Filter Single Stream"

diff --git a/lib/conceptql/operators/trim_date_end.rb b/lib/conceptql/operators/trim_date_end.rb
@@ -15,7 +15,7 @@ module Operators
     class TrimDateEnd < TrimDate
       register __FILE__
 
-      desc "Trims, on a person-by-person basis, the end_date of all left hand records by the earliest start_date in the right hand records."
+      desc "For each person, trims the end_date of all left hand records by the earliest start_date in the right hand records."
 
       allows_one_upstream
 

diff --git a/lib/conceptql/operators/trim_date_start.rb b/lib/conceptql/operators/trim_date_start.rb
@@ -15,7 +15,7 @@ module Operators
     class TrimDateStart < TrimDate
       register __FILE__
 
-      desc "Trims, on a person-by-person basis, the start_date of all left hand records by the most recent end_date in the right hand records."
+      desc "For each person, trims the start_date of all left hand records by the most recent end_date in the right hand records."
 
       allows_one_upstream
 

diff --git a/lib/conceptql/operators/union.rb b/lib/conceptql/operators/union.rb
@@ -27,7 +27,7 @@ def queries(db)
         end
       end
 
-      desc 'Pools sets of incoming records into a single large set of records.'
+      desc 'Combines sets of incoming records into a single large set of records.'
       allows_many_upstreams
       category "Combine Streams"
       default_query_columns