-
Notifications
You must be signed in to change notification settings - Fork 15
/
slides.R
1152 lines (1044 loc) · 35.6 KB
/
slides.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Generics ---------------------------------------------------------------
#nolint start
#' Get and set slide analyses
#'
#' Slides are composed of analyses, which are effectively `CrunchCubes` with some
#' additional metadata. You can get and set a slide's Analysis Catalog with the
#' `analyses` method, and access an individual analysis with `analysis`. There
#' are also helpers to get and set the components of the analysis such as `filter()`,
#' `weight()`, `transforms()`, `displaySettings()` and `vizSpecs()`. You can also
#' get the `CrunchCube` from an analysis using `cube()`.
#'
#' For more complex objects like `displaySettings()`, `vizSpecs()` and `transforms()`,
#' the [API documentation](
#' https://crunch.io/api/reference/#patch-/datasets/-dataset_id-/decks/-deck_id-/slides/-slide_id-/analyses/-analysis_id-/)
#' provides more details.
#'
#' Advanced users of the API can assign a list to `analysis<-` to specify settings
#' on the analyses that are not otherwise available in `rcrunch`. The helpers
#' `formulaToSlideQuery()` and `slideQueryEnv()` help you create objects for the
#' `query` and `query_environment`.
#'
#' @param x a `CrunchSlide`, `AnalysisCatalog`, or `Analysis`
#' @param value for the setter, an object to set it
#' @param query For `formulaToSlideQuery()`, a formula that specifies the query, as in
#' `newSlide()`. See Details of [`crtabs()`] for more information.
#' @param dataset For `formulaToSlideQuery()`, a `CrunchDataset` that the variables in
#' `query` refer to.
#' @param weight For `slideQueryEnv()` a crunch variable to use as a weight or `NULL`
#' to indicate no weight should be used.
#' @param filter for `slideQueryEnv()`, a `CrunchFilter` or `CrunchExpression` to filter
#' the slide.
#' @param ... ignored
#'
#' @rdname analysis-methods
#' @export
#' @examples
#' \dontrun{
#' # Examples of setting analysis details (in general these setters work on
#' # the slide, analysis catalog and analysis, but for brevity the examples only
#' # show on the slide)
#'
#' # Change the filter
#' filters(slide) <- NULL # to remove a filter
#' filters(slide) <- filters(ds)[["My filter"]]
#' filters(slide) <- list( # Can set multiple filter
#' filters(ds)[["My filter"]],
#' ds$age_grp == "18-35"
#' )
#' filters(deck) <- filters(ds)[["My filter"]] # Can set the same filter on a whole deck too
#'
#' # Change the weight
#' weight(slide) <- NULL # to remove
#' weight(slide) <- ds$weight
#' weight(deck) <- ds$weight # Can set the same weight on a whole deck too
#'
#' # Change the transforms
#' transforms(slide) <- list(rows_dimension = makeDimTransform(hide = "Neutral"))
#'
#' # Change the displaySettings
#' displaySettings(slide) <- list(vizType = "groupedBarPlot")
#'
#' # Change the vizSpecs
#' # viz_specs can get quite long, see
#' # https://crunch.io/api/reference/#post-/datasets/-dataset_id-/decks/-deck_id-/slides/
#' vizSpecs(slide) <- viz_specs
#'
#' # Change the query
#' #' query(slide) <- ~ cyl + wt
#' }
#nolint end
setGeneric("analyses", function(x) standardGeneric("analyses"))
#' @rdname analysis-methods
#' @export
setGeneric("analysis", function(x) standardGeneric("analysis"))
#' @rdname analysis-methods
#' @export
setGeneric("analysis<-", function(x, value) standardGeneric("analysis<-"))
#' @rdname analysis-methods
#' @export
setGeneric("query<-", function(x, value) standardGeneric("query<-"))
#' @rdname analysis-methods
#' @export
setGeneric("cube", function(x) standardGeneric("cube"))
#' @rdname analysis-methods
#' @export
setGeneric("cubes", function(x) standardGeneric("cubes"))
#' @rdname newMarkdownSlide
#' @export
setGeneric("slideMarkdown", function(x) standardGeneric("slideMarkdown"))
#' @rdname newMarkdownSlide
#' @export
setGeneric("slideMarkdown<-", function(x, value) standardGeneric("slideMarkdown<-"))
#' @rdname analysis-methods
#' @export
setGeneric("displaySettings", function(x) standardGeneric("displaySettings"))
#' @rdname analysis-methods
#' @export
setGeneric("displaySettings<-", function(x, value) standardGeneric("displaySettings<-"))
#' @rdname analysis-methods
#' @export
setGeneric("vizSpecs", function(x) standardGeneric("vizSpecs"))
#' @rdname analysis-methods
#' @export
setGeneric("vizSpecs<-", function(x, value) standardGeneric("vizSpecs<-"))
# Slide Catalog -----------------------------------------------------------
setMethod("initialize", "SlideCatalog", function(.Object, ...) {
.Object <- callNextMethod()
order <- crGET(.Object@orders$flat)
order <- unlist(order$graph)
.Object@index <- .Object@index[match(order, names(.Object@index))]
return(.Object)
})
#' @rdname describe-catalog
#' @export
setMethod("names", "SlideCatalog", function(x) titles(x))
#' @rdname describe-catalog
#' @export
setMethod("names<-", "SlideCatalog", function(x, value) titles(x) <- value)
#' @rdname deck-titles
#' @export
setMethod("titles", "SlideCatalog", function(x) getIndexSlot(x, "title"))
#' @rdname deck-titles
#' @export
setMethod("titles<-", "SlideCatalog", function(x, value) {
setIndexSlot(x, "title", value)
})
#' @rdname deck-titles
#' @export
setMethod("subtitles", "SlideCatalog", function(x) getIndexSlot(x, "subtitle"))
#' @rdname deck-titles
#' @export
setMethod("subtitles<-", "SlideCatalog", function(x, value) {
setIndexSlot(x, "subtitle", value)
})
#' @rdname crunch-extract
#' @export
setMethod("[[", "SlideCatalog", function(x, i, ...) {
getEntity(x, i, CrunchSlide)
})
#' @rdname crunch-extract
#' @export
setMethod(
"[[<-", c("SlideCatalog", "numeric", "missing", "CrunchSlide"),
function(x, i, j, value) {
if (length(i) > 1) {
# TODO, allow assignment of more than one slide
}
if (i > length(x) + 1) {
# TODO what to do with missing slide entries
i <- length(x) + 1
}
if (i <= length(x)) {
# we are replacing a slide, so return quickly modifying in place
out <- modifyCatalogInPlace(x, i, j, value)
return(out)
}
n_slides <- length(x)
payload <- value@body[c("title", "subtitle")]
anCat <- analyses(value)
payload$analyses <- lapply(seq_along(anCat), function(i) {
out <- anCat[[i]]
# TODO: Make sure API always sends all parts (and no legacy pre-viz_specs)
# and update fixtures
out <- out@body[
na.omit(match(
c("query", "query_environment", "display_settings", "transform", "viz_specs"),
names(out@body)
))
]
out
})
payload <- wrapEntity(body = payload)
crPOST(self(x), body = toJSON(payload))
if (i < n_slides) {
# You can't modify the contents of a slide by patching it
# so we need to add the new slide, delete the original slide,
# and reorder the slideCatalog.
# Is ^^^ really true?
new_order <- moveLastElement(seq_len(n_slides + 1), i)
reorderSlides(x, new_order)
with_consent(delete(x[[length(x)]]))
}
invisible(refresh(x))
}
)
#' Move and delete last element of a vector
#' This moves the last element of a vector to an index, then deletes the last
#' element, it is broken out for testing purposes
#'
#' @param v a vector
#' @param idx The index to move the last element to.
#'
#' @return a vector
#' @keywords internal
moveLastElement <- function(v, idx) {
v[idx] <- v[length(v)]
out <- v[1:(length(v) - 1)]
return(out)
}
#' Reorder slides in a CrunchDeck
#'
#' @param x A SlideCatalog
#' @param order The numeric order for slides to be reordered to.
#'
#' @return A SlideCatalog
reorderSlides <- function(x, order) {
url <- paste0(self(x), "flat")
payload <- crGET(url)
payload$graph <- payload$graph[order]
crPATCH(url, body = toJSON(payload))
return(refresh(x))
}
#' @rdname describe-catalog
#' @export
setMethod("types", "SlideCatalog", function(x) {
getIndexSlot(x, "type")
})
# CrunchSlide -------------------------------------------------------------------
# TODO: Find out what the mandatory display settings should be for the app then
# change this list to reflect those settings.
DEFAULT_DISPLAY_SETTINGS <- list(
percentageDirection = "colPct",
showEmpty = FALSE,
showMean = FALSE,
vizType = "table",
countsOrPercents = "percent",
decimalPlaces = 1L,
showSignif = TRUE,
currentTab = 0L
)
#' Append a new slide to a Crunch Deck
#'
#' @param deck A Crunch Deck
#' @param query A formula definition of a query to be used by the slide. See
#' Details of [`crtabs()`] for more information about making queries.
#' @param display_settings (optional) A list of display settings. If omitted,
#' slide will be a table of column percentages with hypothesis test highlighting
#' enabled. The most common setting used is `vizType`, which can be:
#' `table`, `groupedBarPlot`, `stackedBarPlot`, `horizontalBarPlot`,
#' `horizontalStackedBarPlot`, `donut`, and (if the second variable in the
#' query formula is a wave variable) `timeplot`.
#' In addition, `showValueLabels` (logical) controls whether the web app and
#' exports show labels on bars or arcs of donuts.
#' @param title The slide's title
#' @param subtitle The slide's subtitle
#' @param filter a `CrunchLogicalExpression`, a crunch `filter` object or
#' a vector of names of \code{\link{filters}} defined in the dataset (defaults
#' to `NULL`, using all data).
#' @param weight A weight variable (defaults to NULL, meaning no weight)
#' @param viz_specs Another set of options for the display of the slide, see
#' the [API documentation](
#' https://crunch.io/api/reference/#post-/datasets/-dataset_id-/decks/-deck_id-/slides/)
#' for more information.
#' @param transform A list of slide transformations, usually created using the function
#' [`makeDimTransform()`].
#' @param ... Further options to be passed on to the API
#'
#' @return CrunchSlide object
#' @seealso [`newMarkdownSlide`] for creating a markdown slide
#' @export
#'
#' @examples
#' \dontrun{
#' newSlide(
#' main_deck,
#' ~ cyl + wt,
#' title = "Cyl and Weight",
#' subtitle = "2017 Data"
#' )
#'
#' # Grouped bar plot
#' newSlide(
#' main_deck,
#' ~ approval + age4,
#' title = "Approval by age group",
#' display_settings = list(
#' vizType = "groupedBarPlot",
#' showValueLabels = TRUE
#' ),
#' subtitle = "2017 Data"
#' )
#'
#' # Horizontal stacked bars
#' newSlide(
#' main_deck,
#' ~ approval + age4,
#' title = "Approval by age group",
#' display_settings = list(
#' vizType = "horizontalStackedBarPlot"
#' ),
#' subtitle = "2017 Data"
#' )
#'
#' # A donut is only suitable for a single variable
#' newSlide(
#' main_deck,
#' ~ approval,
#' title = "Approval of new feature",
#' display_settings = list(
#' vizType = "donut",
#' showValueLabels = FALSE
#' ),
#' subtitle = "2017 Data"
#' )
#'
#' # A Grouped bar plot with slide transformations to hide a category
#' newSlide(
#' main_deck,
#' ~ approval + age4,
#' title = "Approval by age group",
#' display_settings = list(
#' vizType = "groupedBarPlot",
#' showValueLabels = TRUE
#' ),
#' transform = list(rows_dimension = makeDimTransform(hide = "Neutral")),
#' subtitle = "2017 Data"
#' )
#'
#' # Example of advanced options being set:
#' # viz_specs can get quite long, see
#' # https://crunch.io/api/reference/#post-/datasets/-dataset_id-/decks/-deck_id-/slides/
#' viz_specs <- list(
#' default = list(
#' format = list(
#' decimal_places = list(percentages = 0L, other = 2L),
#' show_empty = FALSE
#' )
#' ),
#' table = list(
#' measures = c("col_percent", "pairwise_t_test"),
#' page_layout = list(
#' rows = list(
#' top = list(),
#' bottom = c("base_unweighted", "scale_mean", "significant_columns")
#' ),
#' measure_layout = "long"
#' ),
#' pairwise_comparison = list(sig_threshold = c(0.05, 0.01)),
#' format = list(pval_colors = FALSE)
#' )
#' )
#'
#' newSlide(
#' main_deck,
#' ~categories(fav_array)+subvariables(fav_array),
#' display_settings = list(viz_type = list(value = "table")),
#' title = "custom slide",
#' filter = filters(ds)[[1]],
#' weight = ds$weight,
#' viz_specs = viz_specs
#' )
#'
#' # Can also specify `analyses` directly, which allows for very advanced use.
#' # `formulaToSlideQuery()` and `slideQueryEnv()` help describe the API
#' newSlide(
#' main_deck,
#' title = "custom slide",
#' analyses = list(list(
#' query = formulaToSlideQuery(~categories(fav_array)+subvariables(fav_array), ds),
#' query_environment = slideQueryEnv(filter = filters(ds)[[1]]),
#' display_settings = list(viz_type = list(value = "table")),
#' viz_specs = viz_specs
#' ))
#' )
#' }
newSlide <- function(
deck,
query = NULL,
display_settings = list(),
title = "",
subtitle = "",
filter = NULL,
weight = NULL,
viz_specs = NULL,
transform = NULL,
...
) {
stopifnot(inherits(query, "formula") || is.null(query))
settings <- modifyList(DEFAULT_DISPLAY_SETTINGS, display_settings)
settings <- wrapDisplaySettings(settings)
ds <- loadDataset(datasetReference(deck))
filter <- standardize_tabbook_filter(ds, filter)
payload <- list(title = title, subtitle = subtitle, ...)
check_newslide_args(
query, display_settings, payload, filter, weight, viz_specs, transform
)
if (any(dimTransformNeedsPrep(transform))) {
transform <- prepareDimTransforms(transform, query, ds) #nolint
}
if (!is.null(query)) {
query <- formulaToCubeQuery(query, ds)
validateSlideQuery(query)
analysis <- list(
query = query,
display_settings = settings
)
query_environment <- list()
if (!is.null(filter)) query_environment$filter <- filter
if (!is.null(weight)) {
query_environment$weight <- self(weight)
# Also add to the query to match webapp behavior
analysis$query$weight <- self(weight)
}
if (length(query_environment) > 0) analysis$query_environment <- query_environment
if (!is.null(viz_specs)) {
analysis$viz_specs <- viz_specs
}
if (!is.null(transform)) analysis$transform <- transform
payload[["analyses"]] <- list(analysis)
}
payload <- wrapEntity(body = payload)
url <- crPOST(shojiURL(deck, "catalogs", "slides"), body = toJSON(payload))
return(CrunchSlide(crGET(url)))
}
#nolint start
check_newslide_args <- function(
query, display_settings, payload, filter, weight, viz_specs, transform
) {
has_analyses <- "analyses" %in% names(payload)
has_any_analysis_objects <- length(display_settings) != 0 ||
!is.null(filter) ||
!is.null(weight) ||
!is.null(viz_specs) ||
!is.null(transform)
if (has_analyses && !is.null(query)) {
halt("Cannot specify both a `query` and `analyses` for `newSlide()`")
}
if (!has_analyses && is.null(query)) {
halt("Must specify either a `query` or `analyses` for `newSlide()`")
}
if (has_analyses && has_any_analysis_objects) {
warning(paste0(
"`display_settings`, `filter`, `weight`, `viz_specs` and `transform` are ",
"ignored if `analyses` are defined directly for `newSlide()`"
))
}
}
#nolint end
validateSlideQuery <- function(query) {
dimensions <- query$dimensions
if (length(dimensions) < 3) return()
is_subvar_dim <- vapply(dimensions, function(x) {
"function" %in% names(x) &&
x[["function"]] == "dimension" &&
"args" %in% names(x) &&
identical(x[["args"]][[2]], zcl("subvariables"))
}, logical(1))
if (!any(is_subvar_dim)) return()
subvar_args <- lapply(which(is_subvar_dim), function(x) dimensions[[x]][["args"]][[1]])
first_dim_is_array_cat <- vapply(subvar_args, function(x) {
identical(dimensions[[1]], x) ||
identical(dimensions[[1]], zfunc("dimension", x, "categories"))
}, logical(1))
if (any(first_dim_is_array_cat)) {
halt(
"First dimension of 3+ dimension cube for slide analysis cannot be an array's",
"categories. You probably want to use `selectCategories()` to collapse the",
"categorical array's categories dimension."
)
}
}
#' @rdname crunch-extract
#' @export
setMethod("[[", "CrunchAnalysisSlide", function(x, i, ...) {
an_cat <- analyses(x)
return(an_cat[[i]])
})
#' @rdname crunch-extract
#' @export
setMethod("[[<-", "CrunchAnalysisSlide", function(x, i, j, value) {
an_cat <- analyses(x)
an_cat[[i]] <- value
invisible(refresh(x))
})
#' @rdname deck-titles
#' @export
setMethod("title", "CrunchSlide", function(x) {
return(x@body$title)
})
#' @rdname deck-titles
#' @export
setMethod("title<-", "CrunchSlide", function(x, value) {
setEntitySlot(x, "title", value)
})
#' @rdname deck-titles
#' @export
setMethod("subtitle", "CrunchSlide", function(x) {
return(x@body$subtitle)
})
#' @rdname deck-titles
#' @export
setMethod("subtitle<-", "CrunchSlide", function(x, value) {
setEntitySlot(x, "subtitle", value)
})
#' @rdname analysis-methods
#' @export
setMethod("type", "CrunchSlide", function(x) {
return(x@body$type)
})
#' @rdname analysis-methods
#' @export
setMethod("analyses", "CrunchAnalysisSlide", function(x) {
AnalysisCatalog(crGET(shojiURL(x, "catalogs", "analyses")))
})
#' @rdname analysis-methods
#' @export
setMethod("analysis", "CrunchAnalysisSlide", function(x) {
out <- AnalysisCatalog(crGET(shojiURL(x, "catalogs", "analyses")))
return(out[[1]])
})
#' @rdname analysis-methods
#' @export
setMethod("analysis<-", c("CrunchAnalysisSlide", "formula"), function(x, value) {
analysis <- analyses(x)[[1]]
query(analysis) <- value
return(invisible(x))
})
#' @rdname analysis-methods
#' @export
setMethod("analysis<-", c("CrunchAnalysisSlide", "Analysis"), function(x, value) {
analysis_cat <- analyses(x)
return(invisible(modifyCatalogInPlace(analysis_cat, 1, NULL, value)))
})
#' @rdname analysis-methods
#' @export
setMethod("analysis<-", c("CrunchAnalysisSlide", "list"), function(x, value) {
payload <- wrapEntity(body = value)
url <- self(analysis(x))
crPATCH(url, body = toJSON(payload))
invisible(refresh(x))
})
#' @rdname analysis-methods
#' @export
setMethod("filter", "CrunchAnalysisSlide", function(x, ...) {
deprecate_filter("CrunchSlide")
})
#' @rdname analysis-methods
#' @export
setMethod("filters", "CrunchAnalysisSlide", function(x) {
analysis <- analyses(x)[[1]]
return(filters(analysis))
})
#' @rdname analysis-methods
#' @export
setMethod("filters<-", c("CrunchAnalysisSlide", "ANY"), function(x, value) {
# check that there is only on analysis?
first_analysis <- analyses(x)[[1]]
filters(first_analysis) <- value
return(invisible(x))
})
#' @rdname analysis-methods
#' @export
setMethod("query<-", "CrunchAnalysisSlide", function(x, value) {
analysis <- analyses(x)[[1]]
query(analysis) <- value
return(invisible(x))
})
#' @rdname analysis-methods
#' @export
setMethod("cubes", "CrunchAnalysisSlide", function(x) cubes(analyses(x)))
#' @rdname analysis-methods
#' @export
setMethod("cube", "CrunchAnalysisSlide", function(x) cube(analyses(x)[[1]]))
#' @rdname analysis-methods
#' @export
setMethod("displaySettings", "CrunchAnalysisSlide", function(x) displaySettings(analyses(x)))
#' @rdname analysis-methods
#' @export
setMethod("displaySettings<-", "CrunchAnalysisSlide", function(x, value) {
an_cat <- analyses(x)
displaySettings(an_cat) <- value
return(invisible(x))
})
#' @rdname analysis-methods
#' @export
setMethod("vizSpecs", "CrunchAnalysisSlide", function(x) vizSpecs(analyses(x)))
#' @rdname analysis-methods
#' @export
setMethod("vizSpecs<-", "CrunchAnalysisSlide", function(x, value) {
an_cat <- analyses(x)
vizSpecs(an_cat) <- value
return(invisible(x))
})
# AnalysisCatalog --------------------------------------------------------------
setMethod("initialize", "AnalysisCatalog", function(.Object, ...) {
.Object <- callNextMethod()
if (length(.Object@index) > 1) {
order <- crGET(.Object@orders$order)
order <- unlist(order$graph)
.Object@index <- .Object@index[match(order, names(.Object@index))]
}
return(.Object)
})
#' @rdname crunch-extract
#' @export
setMethod("[[", "AnalysisCatalog", function(x, i, ...) {
getEntity(x, i, Analysis)
})
#' @rdname crunch-extract
#' @export
setMethod(
"[[<-", c("AnalysisCatalog", "numeric", "missing", "formula"),
function(x, i, j, value) {
if (i > length(x)) {
halt(
"Index out of bounds, you can only assign a formula to an ",
"existing analysis."
)
}
analysis <- x[[i]]
query(analysis) <- value
invisible(refresh(x))
}
)
#' @rdname crunch-extract
#' @export
setMethod(
"[[<-", c("AnalysisCatalog", "numeric", "missing", "Analysis"),
function(x, i, j, value) {
if (length(i) > 1) {
# TODO, recurse through i
}
if (i > length(x) + 1) {
# TODO what to do with adding an analysis that's not the next one.
}
# TODO: Make sure API always sends all parts (and no legacy pre-viz_specs)
# and update fixtures
payload <- value@body[
na.omit(match(
c("query", "display_settings", "query_environment", "viz_specs", "transform"),
names(value@body)
))
]
payload <- wrapEntity(body = payload)
if (i <= length(x)) {
url <- names(x@index)[i]
crPATCH(url, body = toJSON(payload))
} else {
crPOST(self(x), body = toJSON(payload))
}
invisible(refresh(x))
}
)
#' @rdname crunch-extract
#' @export
setMethod(
"[[<-", c("AnalysisCatalog", "numeric", "missing", "list"),
function(x, i, j, value) {
all_fmla <- vapply(value, function(x) inherits(x, "formula"), logical(1))
if (any(!all_fmla)) {
halt("Entry ", which(!all_fmla), " is not a formula")
}
if (length(i) != length(value)) {
noun <- if (length(i) == 1) " analysis." else " analyses."
halt(
"Invalid assignment. You tried to assign ", length(value),
" formulas to ", length(i), noun
)
}
mapply(function(analysis, fmla) {
analysis <- fmla
}, analysis = x[[i]], fmla = value)
}
)
#' @rdname analysis-methods
#' @export
setMethod("cubes", "AnalysisCatalog", function(x) {
lapply(seq_along(x@index), function(i) cube(x[[i]]))
})
#' @rdname analysis-methods
#' @export
setMethod("displaySettings", "AnalysisCatalog", function(x) {
settings_list <- lapply(seq_along(x), function(i) {
displaySettings(x[[i]])
})
if (length(settings_list) == 1) {
return(settings_list[[1]])
} else {
return(settings_list)
}
})
#' @rdname analysis-methods
#' @export
setMethod("displaySettings<-", c("AnalysisCatalog", "list"), function(x, value) {
analyses <- lapply(seq_along(x), function(i) x[[i]])
lapply(analyses, function(x) displaySettings(x) <- value)
})
#' @rdname analysis-methods
#' @export
setMethod("vizSpecs", "AnalysisCatalog", function(x) {
settings_list <- lapply(seq_along(x), function(i) {
vizSpecs(x[[i]])
})
if (length(settings_list) == 1) {
return(settings_list[[1]])
} else {
return(settings_list)
}
})
#' @rdname analysis-methods
#' @export
setMethod("vizSpecs<-", c("AnalysisCatalog", "list"), function(x, value) {
analyses <- lapply(seq_along(x), function(i) x[[i]])
lapply(analyses, function(x) vizSpecs(x) <- value)
})
# Analysis ----------------------------------------------------------------
#' @rdname analysis-methods
#' @export
setMethod("query<-", c("Analysis", "formula"), function(x, value) {
ds <- loadDataset(datasetReference(x))
payload <- list(query = formulaToCubeQuery(value, data = ds))
payload <- wrapEntity(body = payload)
crPATCH(self(x), body = toJSON(payload))
return(invisible(refresh(x)))
})
#' @rdname analysis-methods
#' @export
formulaToSlideQuery <- function(query, dataset) {
formulaToCubeQuery(query, dataset)
}
#' @rdname analysis-methods
#' @export
setMethod("cube", "Analysis", function(x) {
# Always use the weight from the query_environment (even if missing in qe, we want to
# override with no weight in this case)
cube_query <- x@body$query
cube_query$weight <- NULL
# Actually want weight=NULL to override the default dataset weight
cube_query <- c(cube_query, list(weight = x@body$query_environment$weight))
http_query <- list(query = toJSON(cube_query, for_query_string = TRUE))
# Don't pass filter=NULL because API's probably grumpy about that. Also, rather than pass a
# list of filters if there are multiple, the API expects multiple `filter=` URL query
# parameters
qe_filters <- x@body$query_environment$filter
if (length(qe_filters) > 0) {
qe_filters <- lapply(qe_filters, function(filt) toJSON(filt, for_query_string = TRUE))
names(qe_filters) <- rep("filter", length(qe_filters))
http_query <- c(http_query, qe_filters)
}
CrunchCube(crGET(
cubeURL(x),
query = http_query
))
})
#' @rdname analysis-methods
#' @export
setMethod("displaySettings", "Analysis", function(x) {
lapply(x@body$display_settings, function(x) x$value)
})
#' @rdname analysis-methods
#' @export
setMethod("displaySettings<-", "Analysis", function(x, value) {
settings <- modifyList(displaySettings(x), value)
settings <- wrapDisplaySettings(settings)
payload <- list(display_settings = settings)
payload <- wrapEntity(body = payload)
crPATCH(self(x), body = toJSON(payload))
invisible(refresh(x))
})
#' @rdname analysis-methods
#' @export
setMethod("vizSpecs", "Analysis", function(x) {
x@body$viz_specs
})
#' @rdname analysis-methods
#' @export
setMethod("vizSpecs<-", "Analysis", function(x, value) {
payload <- wrapEntity(body = list(viz_specs = value))
crPATCH(self(x), body = toJSON(payload))
invisible(refresh(x))
})
# This processes a names list of display setting values to the form that is
# required by the API.
wrapDisplaySettings <- function(settings) {
return(lapply(settings, function(x) list(value = x)))
}
#' @rdname analysis-methods
#' @export
setMethod("filter", "Analysis", function(x, ...) {
deprecate_filter("Analysis")
})
#' @rdname analysis-methods
#' @export
setMethod("filters", "Analysis", function(x) {
filters <- x@body$query_environment$filter
.filtersFromSlide(filters, ds_ref = datasetReference(x))
})
.filtersFromSlide <- function(filters, ds_ref) {
if (length(filters) == 0) {
return(NULL)
}
# jsonlite unboxes a single filter so it's no longer a list of lists
# but to make code more consistent, we add it back.
if (!is.null(names(filters))) {
filters <- list(filters)
}
lapply(filters, function(filt) {
if ("filter" %in% names(filt)) {
CrunchFilter(crGET(filt$filter))
} else {
# an adhoc filter
adhoc_expr <- CrunchLogicalExpr(
expression = idsToURLs(
# 02/2021: Not sure if this is still needed anymore, server doesn't
# currently seem to be sending the `dataset` attributes this takes out.
# But mocks require it (/4/decks/8ad8/slides/72e8/analysies/52fb.json)
fixAdhocFilterExpression(filt),
paste0(ds_ref, "/variables/")
),
dataset_url = ds_ref
)
adhoc_expr
}
})
}
#' @rdname analysis-methods
#' @export
setMethod("filter", "ANY", function(x, ...) {
for (searchpath in search()) {
func <- get("filter", as.environment(searchpath))
if (!identical(func, crunch::filter)) {
return(func(x, ...))
}
}
halt("No method found for filter for object of type ", dQuote(methods::getClass(x))) # nocov
})
#' @rdname analysis-methods
#' @export
setMethod("filter<-", "CrunchAnalysisSlide", function(x, value) {
deprecate_filter("Analysis", arrow = TRUE)
})
#' @rdname analysis-methods
#' @export
setMethod("filter<-", "Analysis", function(x, value) {
deprecate_filter("Analysis", arrow = TRUE)
})
#' @rdname analysis-methods
#' @export
setMethod("filters<-", c("Analysis", "CrunchLogicalExpr"), function(x, value) {
return(set_analysis_filter_or_weight(x, filter = list(value@expression)))
})
#' @rdname analysis-methods
#' @export
setMethod("filters<-", c("Analysis", "CrunchFilter"), function(x, value) {
# crPATCH(self(x), body = toJSON(frmt))
return(set_analysis_filter_or_weight(x, filter = standardize_filter_list(value)))
})
#' @rdname analysis-methods
#' @export
setMethod("filters<-", c("Analysis", "NULL"), function(x, value) {
# crPATCH(self(x), body = toJSON(frmt))
return(set_analysis_filter_or_weight(x, filter = list()))
})
#' @rdname analysis-methods
#' @export
setMethod("filters<-", c("Analysis", "list"), function(x, value) {
filter <- standardize_filter_list(value)
return(set_analysis_filter_or_weight(x, filter = filter))
})
#' @rdname analysis-methods
#' @export
slideQueryEnv <- function(weight, filter) {
if (missing(weight) && missing(filter)) {
halt("Must specify at least one of `weight` or `filter`")
}
out <- list()
if (!missing(weight)) {
out$weight <- if (is.null(weight)) list() else self(weight)
}
if (!missing(filter)) {
if (is.null(filter)) {
out$filter <- list()
} else if (is.CrunchExpr(filter)) {
out$filter <- list(filter@expression)
} else {
out$filter <- list(self(filter))
}
}
out
}
#' @rdname analysis-methods
#' @export
setMethod("cubes", "CrunchDeck", function(x) {
slide_types <- types(x)
out <- lapply(seq_len(length(x)), function(i) {
if (slide_types[i] != "analysis") return(NULL) # Markdown slides don't have cubes
cubes <- cubes(x[[i]])
# If a slide has several analyses we should return a sublist of
# cubes, but most of the time they will have one analysis so not
# including the sublist is preferable.
if (length(cubes) == 1) {
cubes <- cubes[[1]]
}
return(cubes)
})
names(out) <- titles(x)
return(out)
})
#' @rdname analysis-methods
#' @export
setMethod("weight", "CrunchAnalysisSlide", function(x) {
analysis <- analyses(x)[[1]]
return(weight(analysis))
})
#' @rdname analysis-methods
#' @export
setMethod("weight<-", c("CrunchAnalysisSlide", "ANY"), function(x, value) {
# check that there is only on analysis?