diff --git a/inst/images/pipeline.png b/inst/images/pipeline.png new file mode 100644 index 00000000..917141c2 Binary files /dev/null and b/inst/images/pipeline.png differ diff --git a/inst/images/pipeline2.png b/inst/images/pipeline2.png new file mode 100644 index 00000000..e1823ea7 Binary files /dev/null and b/inst/images/pipeline2.png differ diff --git a/inst/umls/pipeline.puml b/inst/umls/pipeline.puml new file mode 100644 index 00000000..42394a36 --- /dev/null +++ b/inst/umls/pipeline.puml @@ -0,0 +1,93 @@ +@startuml +set namespaceSeparator none +skinparam linetype polyline +skinparam backgroundcolor transparent + +Entity "raw data && metadata" as RD {} + +Entity "data.table(s)" as DF {} + +Entity "SummarizedExperiment" as SE { + metadata(se) + rowData(se) + colData(se) + .. assays(se) .. + + **"RawTreated"** + + **"Controls"** +} + +Entity "SummarizedExperiment" as SE2 { + metadata(se) + rowData(se) + colData(se) + .. assays(se) .. + + "RawTreated" + + "Controls" + + **"Normalized"** + + **"RefRelativeViability"** + + **"RefGRvalue"** +} + +Entity "SummarizedExperiment" as SE3 { + metadata(se) + rowData(se) + colData(se) + .. assays(se) .. + + "RawTreated" + + "Controls" + + "Normalized" + + "RefRelativeViability" + + "RefGRvalue" + + **"Averaged"** +} + +Entity "SummarizedExperiment" as SE4 { + metadata(se) + rowData(se) + colData(se) + .. assays(se) .. + + "RawTreated" + + "Controls" + + "Normalized" + + "RefRelativeViability" + + "RefGRvalue" + + "Averaged" + + **"Metrics"** + - **Isobologram** + - **Excess** + - **Scores** +} + +RD --> DF +note right on link +merge template, readouts, treatments, conditions +end note +DF --> SE: " create_SE()" +note right on link +Creates a SummarizedExperiment object with 2 asssays: +1) a raw, treated, BumpyMatrix named "RawTreated" +2) a raw, untreated, BumpyMatrix named "Controls" + - maps treated to untreated references + - averages untreated references +end note +SE --> SE2: " normalize_SE()" +note right on link +Normalize the treated readouts to their corresponding end note +reference readout to compute a RelativeViability and GRvalue +for both the references and treated conditions. +end note +SE2 --> SE3: " average_SE()" +note right on link +Average the replicates for the treated readout values. +reference readout to compute a RelativeViability and GRvalue +for both the references and treated conditions. +end note +SE3 --> SE4: " fit_SE()" +note right on link +Fit a dose response curve to the SE, +and get back fit metrics for the curves + - utilize the RefRelativeViability and RefGRValue +end note + +@enduml + diff --git a/inst/umls/pipeline2.puml b/inst/umls/pipeline2.puml new file mode 100644 index 00000000..0bec4d4f --- /dev/null +++ b/inst/umls/pipeline2.puml @@ -0,0 +1,41 @@ +@startuml +set namespaceSeparator none +skinparam linetype polyline +skinparam backgroundcolor transparent + +Entity "raw data && metadata" as RD {} + +Entity "data.table(s)" as DF {} + +package MultiAssayExperiment as MAE <> { +Entity "SummarizedExperiment(s)" as SE { + metadata(se) + rowData(se) + colData(se) + .. assays(se) .. + + "RawTreated" + + "Controls" + + "Normalized" + + "RefRelativeViability" + + "RefGRvalue" + + "Averaged" + + **"Metrics"** + - **Isobologram** + - **Excess** + - **Scores** +} +} + + +RD --> DF +note right on link +merge template, readouts, treatments, conditions +end note + +DF --> MAE: " runDrugResponseProcessingPipeline()" +note right on link +generate an MAE with processed and analyzed data +end note + + +@enduml diff --git a/inst/umls/refresh.sh b/inst/umls/refresh.sh new file mode 100644 index 00000000..aa496458 --- /dev/null +++ b/inst/umls/refresh.sh @@ -0,0 +1,7 @@ +# sudo apt-get install plantuml +# pretty old version +#jar_path="/usr/share/platinuml/platinuml.jar" +# https://github.com/plantuml/plantuml/releases/download/v1.2023.13/plantuml-1.2023.13.jar +jar_path="./plantuml-1.2023.13.jar" +#java -Djava.awt.headless=true -jar $jar_path *.puml -tsvg -o ../images/ +java -Djava.awt.headless=true -jar $jar_path *.puml -tpng -o ../images/