Module: Panoptes::Client::Subjects

Included in:
Panoptes::Client
Defined in:
lib/panoptes/client/subjects.rb

Instance Method Summary collapse

Instance Method Details

#retire_subject(workflow_id, subject_id, reason: nil) ⇒ Object

TODO:

Add this endpoint to the Apiary docs and add a see-reference here.

Retire a subject for a workflow

Parameters:

  • workflow_id (Integer) —

    the ID of a workflow

  • subject_id (Integer) —

    the ID of a subject associated with that workflow (through one of the assigned subject_sets)

Returns:

  • nothing



25
26
27
28
29
30
31
32
 
# File 'lib/panoptes/client/subjects.rb', line 25

def retire_subject(workflow_id, subject_id, reason: nil)
  panoptes.post("/workflows/#{workflow_id}/retired_subjects", {
    admin: true,
    subject_id: subject_id,
    retirement_reason: reason
  })
  true
end

#subjects(subject_set_id: nil, workflow_id: nil) ⇒ Object

Get list of subjects

Parameters:

  • subject_set_id (Integer) (defaults to: nil) —

    filter by subject set

Returns:

  • list of subjects



8
9
10
11
12
13
14
15
16
17
 
# File 'lib/panoptes/client/subjects.rb', line 8

def subjects(subject_set_id: nil, workflow_id: nil)
  query = {}
  query[:subject_set_id] = subject_set_id if subject_set_id
  query[:workflow_id] = workflow_id if workflow_id

  raise 'Must filter on at least one of subject_set_id, workflow_id' if query.empty?

  response = panoptes.paginate("/subjects", query)
  response.fetch("subjects")
end