This topic is under construction for the 17.3 release of LabKey Server. For current documentation of this feature, click here.
Instrument data becomes even more useful when integrated with other data about the same participants or specimens in a LabKey Study
. For example, assay data can track how a blood marker changes over time. After integration, you can compare trends in that marker for patients receiving different treatments and draw more useful conclusions.
Despite the name, assay data "copied to study" is not duplicated at all. Assay data records are mapped to the study's participants and visits. Within the study, a new dataset is created which includes the assay data using a lookup
. This allows you to:
- Easily integrate assay data with clinical data.
- Create a broad range of visualizations, such as time charts.
- Utilize qc and workflow tools.
Manual Copy of Assay Data
Assay data that has already been uploaded can be copied manually into as study.
- Navigate to the grid view of the assay run(s).
- Select the desired runs in the checkbox column.
- Click Copy to Study.
- Select the target study from the drop down list.
- Click Next.
- Each row will show a "green check" or "red X" icon indicating whether it can be resolved to a specimen in that study. For details on what these icons indicate, see below: What Do Green Checks and Red X's Mean?.
- Click Copy to Study to complete the integration.
- You will see the new assay dataset within the target study. It is named for the assay design and now connected to the other participants in the study.
- Click a participant ID to see other information about that participant. Go back in your browser to return to the copied dataset.
- Notice the View Source Assay link above the grid. Click it to return to your original assay folder.
- Click View Copy-to-Study History to see how the copy you just made was recorded.
- You can also see which rows were copied in the grid view of the assay data. Click the link "copied" to navigate to the copied dataset in the target study.
Automatic Copy-to-Study upon Import
When you always plan to copy all rows to the same study, you can automate the above manual process by building it directly into the assay design. Each run uploaded will then be automatically copied to the target study.
- In your assay folder, click the name of your assay design.
- Select Manage Assay Design > Edit Assay Design. If you want to preserve the non-copying original design, select "Copy Assay Design" instead and copy it to the current folder, giving it a new name.
- Placed a checkmark next to Auto-copy Data.
- Select the target study from the Auto-copy Target dropdown list.
- Click Save & Close.
- The next data imported using this assay design will have all rows copied to the target study.
- You can find "copied-to-study" datasets in study on the Clinical and Assay Data tab. Until otherwise assigned a category, datasets added from assays will be "Uncategorized."
Recall Copied Rows
If you have edit permission on the copied dataset in the target study, you have the option to "recall" the copied row(s). Select one or more rows and click Recall
. When rows are recalled, they are deleted from the target study dataset.
The recall action is recorded on the "View Copy-to-Study History" page in the assay folder.
Hover over the leftmost column in the grid for a cog
icon. Click it for more details about that row.
What Do Green Checks and Red X's Mean?
The "green check" or "red X" icons when copying are relevant to specimen matches only
. A red X does not necessarily mean the copy-to-study process should not proceed or does not make sense. For example, red X's will always be shown when copying into a study that contains no specimens.
When assay data is copied to a study, it must be resolved to participants and dates or visits in the target study. There are several ways to provide this information, and participants and visits that do not already exist will be created. See Participant/Visit Resolver Field
. Matching incoming assay data to specimens
is done when possible, but integrated assay data is still of use without such a match.
If the server can resolve a given ParticipantId/Visit pair in the assay data with a matching ParticipantId/Visit pair in the study, then it will incorporate the assay data into the existing visit structure of the study. If the server cannot resolve a given Participant/Visit pair in the assay data, then it will create a new participant and/or a new visit in the study to accommodate the new, incoming data from the assay. The assay data in copied into the study in either case, the difference is that in one case (when the assay data can be resolved) no new Visits or Participants are created in the study, in the other case (when the assay data cannot be resolved) new Visits and Participants will be created in the study.