Skip to content

use-case-42A-Link-Papers-to-Script-Runs.rst

Latest commit

 

History

History
74 lines (57 loc) · 2.31 KB

use-case-42A-Link-Papers-to-Script-Runs.rst

File metadata and controls

74 lines (57 loc) · 2.31 KB

DataONE Use Case 42A (Link Papers to Script Runs)

Scientists can link papers to specific runs of scripts

Revisions

Created: 2014-09-23
Revised: 2014-10-14

Goal

Scientist can provide links to scholalrly papers that were derived from particular executions of a script or model.

Scenario

"As a scientist using R or Matlab, I want to link my paper to a given script run so I can document the exact process I used to derive my published data, figures, or tables."

Summary

In R or Matlab, after executing a script and recording provenance information about the run, a scientist can later update the execution's provenance information by providing a link to a permanent identifier (such as a DOI) of a published document.

Use case diagram

images/use-case-42A.png

Sequence diagram

images/sequence-42A.png

Actors

  • Investigator
  • Client Software

Preconditions

  • The necessary DataONE run manager packages have been installed in R or Matlab

Triggers

  • Scientist invokes the run manager list() function, providing search terms to select matching executions
  • Scientist invokes the run manager insertRelationship() function, providing the relationship type, paper reference, and execution id

Post Conditions

  • The scientist has updated the execution's provenance information
⚡