From 28f4828f3e5dcccb7a59bc8d053cf470f0228fc2 Mon Sep 17 00:00:00 2001 From: jryurkanin <104916543+jryurkanin@users.noreply.github.com> Date: Thu, 28 Dec 2023 09:01:12 -0800 Subject: [PATCH 1/2] Create experiment.md --- docs/experiment.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 docs/experiment.md diff --git a/docs/experiment.md b/docs/experiment.md new file mode 100644 index 0000000..f429fbd --- /dev/null +++ b/docs/experiment.md @@ -0,0 +1,29 @@ +# LabKey Experiment API Overview + +Load or save LabKey assay batches associated with existing assays/protocols. + +An assay batch is a set of runs uploaded in a single session. Some properties in a design apply to entire batches of runs. This python API lets users retrieve batch data and save new batch data to their LabKey Server instance. + +Learn more about assays here, https://www.labkey.org/Documentation/wiki-page.view?name=instrumentData. + +### LabKey Experiment API Methods + +To use the experiment API methods, you must first instantiate an APIWrapper object. See the APIWrapper docs page to learn more about how to properly do so, accounting for your LabKey Server's configuration details. + +**load_batch** + +List of method parameters: +- assay_id: The protocol id of the assay from which to load a batch. +- batch_id: The id of the batch being loaded. + +**save_batch** + +List of method parameters: +- assay_id: The assay protocol id. +- batch: The Batch to save. + +**save_batches** + +List of method parameters: +- assay_id: The assay protocol id. +- batches: The Batch(es) to save. From bba1da456dac6fc881b24c4421ea675a2381afac Mon Sep 17 00:00:00 2001 From: jryurkanin <104916543+jryurkanin@users.noreply.github.com> Date: Sun, 14 Jan 2024 15:18:17 -0800 Subject: [PATCH 2/2] Update experiment.md --- docs/experiment.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/experiment.md b/docs/experiment.md index f429fbd..3132876 100644 --- a/docs/experiment.md +++ b/docs/experiment.md @@ -27,3 +27,7 @@ List of method parameters: List of method parameters: - assay_id: The assay protocol id. - batches: The Batch(es) to save. + +### Examples + +For more information about how to use the experiment API in practice, please see the /samples/experiment_example.py file.