diff --git a/signalData/.gitattributes b/signalData/.gitattributes new file mode 100644 index 000000000..176a458f9 --- /dev/null +++ b/signalData/.gitattributes @@ -0,0 +1 @@ +* text=auto diff --git a/signalData/.gitignore b/signalData/.gitignore new file mode 100644 index 000000000..32858aad3 --- /dev/null +++ b/signalData/.gitignore @@ -0,0 +1,12 @@ +*.class + +# Mobile Tools for Java (J2ME) +.mtj.tmp/ + +# Package Files # +*.jar +*.war +*.ear + +# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* diff --git a/signalData/LICENSE.txt b/signalData/LICENSE.txt new file mode 100644 index 000000000..8f71f43fe --- /dev/null +++ b/signalData/LICENSE.txt @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/signalData/README.md b/signalData/README.md new file mode 100644 index 000000000..554d36b83 --- /dev/null +++ b/signalData/README.md @@ -0,0 +1,79 @@ +# SignalData + +## Basic Setup ## + +1. Create a LabKey Assay Project/Folder + 1. Hover over the Project or Folder menu, and click **Create Project** or **Create Subfolder**. + 1. Provide a Name and select type **Assay**. + 1. Click **Next**. + 1. Set permissions (optional) and click **Next**. + 1. Click **Finish**. +1. Create a Signal Data Assay Design + 1. In the **Assay List** web part, click **New Assay Design**. + 1. On the New Assay Design page, select **Signal Data** as the assay type. + 1. Click **Next**. + 1. Name is the only required field. (Design default values should work fine.) + 1. Click the **Save & Close** button. + +## Manual Import of Signal Data Results ## + +Importing data is a two step process: + +1. Upload the metadata file. (An example metadata file is available at: https://github.com/LabKey/signalData/blob/develop/test/sampledata/signaldata/RunsMetadata/datafiles.tsv) +1. Drag and drop the data files (Example data files are available at: https://github.com/LabKey/signalData/tree/develop/test/sampledata/signaldata/SignalDataAssayData/TestRun001) + +### Metadata Upload + +1. Go to the folder where you wish to upload results. +1. Add the **Signal Data Upload** webpart. +1. Confirm that **File** is selected, and click **Upload TXT, TSV, XLS, XLSX**. + +![Drag-and-drop to upload a run](https://github.com/LabKey/docs/blob/master/images/signal1.png?raw=true) + +1. Specify a Run Identifier (required). + +![Drag-and-drop to upload a run](https://github.com/LabKey/docs/blob/master/images/signal2.png?raw=true) + +### Data Upload + +1. Drag-and-drop any result files you want to import onto the dropzone. + +![Drag-and-drop to upload a run](https://github.com/LabKey/docs/blob/master/images/signal3.png?raw=true) + +1. Click the **Save Run** button. + +![Name and save a run](https://github.com/LabKey/docs/blob/master/images/signal4.png?raw=true) + +## View Results ## + +To view chromatograms for the results, follow these instructions: + +1. Go to the folder where your results reside. +1. On the **Assay List** webpart, click the name of the Signal Data assay you created. +1. Select the run(s) you want to look at, using the checkboxes. +1. Click **View Selected Runs**. + +![View runs](https://github.com/LabKey/docs/blob/master/images/hplc3.png?raw=true) + +1. Select the data run(s) you wish to view from the left. +1. Click the `Overlay Selected` button. + +![View runs](https://github.com/LabKey/docs/blob/master/images/hplc4.png?raw=true) + +1. The left selection pane will close, and the overlayed results will be displayed in the center pane. + +![View runs](https://github.com/LabKey/docs/blob/master/images/hplc5.png?raw=true) + +1. You can zoom into the graph by entering values in the **Time** and **mV Range** text boxes, or by drawing a new area inside the graph using the mouse. + +![View runs](https://github.com/LabKey/docs/blob/master/images/hplc6.png?raw=true) + +Enter values in the right pane to calculate areas under the curves. Select in the name column to highlight different graph lines. + +![View runs](https://github.com/LabKey/docs/blob/master/images/hplc7.png?raw=true) + +## Installing the Signal Data Module ## + +[Contact us](https://www.labkey.com/company/contact-us) for details on installing the Signal Data module. + + diff --git a/signalData/build.gradle b/signalData/build.gradle new file mode 100644 index 000000000..405ae2406 --- /dev/null +++ b/signalData/build.gradle @@ -0,0 +1,3 @@ +plugins { + id 'org.labkey.build.module' +} diff --git a/signalData/module.properties b/signalData/module.properties new file mode 100644 index 000000000..acc479342 --- /dev/null +++ b/signalData/module.properties @@ -0,0 +1,7 @@ +ModuleClass: org.labkey.signaldata.SignalDataModule +Label: signaldata +Description: A module defining general X/Y plottable assays and tools for working with those assays. +URL: https://github.com/LabKey/signalData +License: Apache 2.0 +LicenseURL: http://www.apache.org/licenses/LICENSE-2.0 +ManageVersion: true diff --git a/signalData/resources/assay/signalData/config.xml b/signalData/resources/assay/signalData/config.xml new file mode 100644 index 000000000..fd5ee4ae6 --- /dev/null +++ b/signalData/resources/assay/signalData/config.xml @@ -0,0 +1,7 @@ + + Signal Data + X/Y plottable Signal Data + + SignalData + + diff --git a/signalData/resources/assay/signalData/domains/batch.xml b/signalData/resources/assay/signalData/domains/batch.xml new file mode 100644 index 000000000..1915a5e35 --- /dev/null +++ b/signalData/resources/assay/signalData/domains/batch.xml @@ -0,0 +1,19 @@ + + Signal Data Assay Batch fields + + XAxis + true + http://www.w3.org/2001/XMLSchema#string + X-Axis Label + FixedValue + Time (m) + + + YAxis + true + http://www.w3.org/2001/XMLSchema#string + Y-Axis Label + FixedValue + mV + + \ No newline at end of file diff --git a/signalData/resources/assay/signalData/domains/result.xml b/signalData/resources/assay/signalData/domains/result.xml new file mode 100644 index 000000000..3c859714d --- /dev/null +++ b/signalData/resources/assay/signalData/domains/result.xml @@ -0,0 +1,14 @@ + + Signal Data Assay Results + + Name + true + http://www.w3.org/2001/XMLSchema#string + + + DataFile + true + http://cpas.fhcrc.org/exp/xml#fileLink + Data File + + diff --git a/signalData/resources/assay/signalData/domains/run.xml b/signalData/resources/assay/signalData/domains/run.xml new file mode 100644 index 000000000..cebcdfcbd --- /dev/null +++ b/signalData/resources/assay/signalData/domains/run.xml @@ -0,0 +1,8 @@ + + + RunIdentifier + true + http://www.w3.org/2001/XMLSchema#string + Run Identifier + + diff --git a/signalData/resources/assay/signalData/queries/Data.query.xml b/signalData/resources/assay/signalData/queries/Data.query.xml new file mode 100644 index 000000000..332e31863 --- /dev/null +++ b/signalData/resources/assay/signalData/queries/Data.query.xml @@ -0,0 +1,42 @@ + + + + + + + /signaldata/update.view?protocolId=${Run/Protocol/RowId}&batchId=${Run/Batch/RowId}&runId=${Run/RowId}&rowId=${RowId}&runName=${Run/Name} + + /signaldata/QCView/SignalData.js + + LABKEY.SignalData.signalDataSelection(dataRegion, dataRegionName, 'signaldata') + + + + + + + SearchSignalDataData + RowId + + + +
+
+
+
diff --git a/signalData/resources/assay/signalData/queries/SearchSignalDataData.sql b/signalData/resources/assay/signalData/queries/SearchSignalDataData.sql new file mode 100644 index 000000000..f705afa47 --- /dev/null +++ b/signalData/resources/assay/signalData/queries/SearchSignalDataData.sql @@ -0,0 +1,23 @@ +/* + * Copyright (c) 2016 LabKey Corporation + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +-- noinspection SqlDialectInspectionForFile +-- noinspection SqlNoDataSourceInspectionForFile +-- This query is used to define the search criteria as used for the SignalData initial view +SELECT +Data.RowId, +--TODO: Identify search fields +COALESCE(Data.Name, '') || COALESCE(Data.Run.RunIdentifier, '')AS Search +FROM Data \ No newline at end of file diff --git a/signalData/resources/assay/signalData/views/begin.html b/signalData/resources/assay/signalData/views/begin.html new file mode 100644 index 000000000..280ee5221 --- /dev/null +++ b/signalData/resources/assay/signalData/views/begin.html @@ -0,0 +1,45 @@ +
+ + +
+
+ \ No newline at end of file diff --git a/signalData/resources/assay/signalData/views/begin.view.xml b/signalData/resources/assay/signalData/views/begin.view.xml new file mode 100644 index 000000000..5fbe3ce56 --- /dev/null +++ b/signalData/resources/assay/signalData/views/begin.view.xml @@ -0,0 +1,5 @@ + + + + + diff --git a/signalData/resources/assay/signalData/views/upload.html b/signalData/resources/assay/signalData/views/upload.html new file mode 100644 index 000000000..3c251b032 --- /dev/null +++ b/signalData/resources/assay/signalData/views/upload.html @@ -0,0 +1,9 @@ +
+ \ No newline at end of file diff --git a/signalData/resources/views/mockSignalDataWatch.html b/signalData/resources/views/mockSignalDataWatch.html new file mode 100644 index 000000000..7eeded323 --- /dev/null +++ b/signalData/resources/views/mockSignalDataWatch.html @@ -0,0 +1,232 @@ + +
+
+ diff --git a/signalData/resources/views/mockSignalDataWatch.view.xml b/signalData/resources/views/mockSignalDataWatch.view.xml new file mode 100644 index 000000000..1e4bca528 --- /dev/null +++ b/signalData/resources/views/mockSignalDataWatch.view.xml @@ -0,0 +1,5 @@ + + + + + diff --git a/signalData/resources/views/qc.html b/signalData/resources/views/qc.html new file mode 100644 index 000000000..d35cdc48a --- /dev/null +++ b/signalData/resources/views/qc.html @@ -0,0 +1,10 @@ +
+ diff --git a/signalData/resources/views/qc.view.xml b/signalData/resources/views/qc.view.xml new file mode 100644 index 000000000..1f2474cdd --- /dev/null +++ b/signalData/resources/views/qc.view.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/signalData/resources/views/signalDataUpload.html b/signalData/resources/views/signalDataUpload.html new file mode 100644 index 000000000..91c86d742 --- /dev/null +++ b/signalData/resources/views/signalDataUpload.html @@ -0,0 +1,59 @@ +

Signal Data Files

+
    +
  1. + Import (or paste) the results file. Data must include a column that has the signal data filename (case-sensitive). +
    Download Spreadsheet Template
    +
  2. +
  3. + Enter Run-level data and import the relevant signal data files. +
  4. +
+
+ + + + + + + + + +
Upload Type: + Cut/Paste
+ File +
Data: +
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/signalData/resources/views/signalDataUpload.view.xml b/signalData/resources/views/signalDataUpload.view.xml new file mode 100644 index 000000000..f529f151b --- /dev/null +++ b/signalData/resources/views/signalDataUpload.view.xml @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/signalData/resources/views/signalDataUpload.webpart.xml b/signalData/resources/views/signalDataUpload.webpart.xml new file mode 100644 index 000000000..6635cc2fb --- /dev/null +++ b/signalData/resources/views/signalDataUpload.webpart.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/signalData/resources/views/update.html b/signalData/resources/views/update.html new file mode 100644 index 000000000..d7b200603 --- /dev/null +++ b/signalData/resources/views/update.html @@ -0,0 +1,5 @@ +

+ Update Signal Data result +

+
+
\ No newline at end of file diff --git a/signalData/resources/views/update.view.xml b/signalData/resources/views/update.view.xml new file mode 100644 index 000000000..b30f54a90 --- /dev/null +++ b/signalData/resources/views/update.view.xml @@ -0,0 +1,12 @@ + + + + + + + + + + + + diff --git a/signalData/resources/web/signaldata-upload.lib.xml b/signalData/resources/web/signaldata-upload.lib.xml new file mode 100644 index 000000000..c17acc494 --- /dev/null +++ b/signalData/resources/web/signaldata-upload.lib.xml @@ -0,0 +1,13 @@ + + +