hlpr_caption_add_on: Clarifying caption

Description Usage Arguments

View source: R/helper-family.R

Description

Returns a ggplot2::labs()-add on in which the caption clarifies whether the plot refers to the times pan before the treatment, after the treatment or to the entire experiment.

If there was not treatment or the cells were treated right from the beginning no caption is returned.

Usage

1
hlpr_caption_add_on(object, phase)

Arguments

object

A valid cell tracer object.

phase

Character value. Refers to the phase of the experiment. Valid inputs are:

'before_tmt'

Uses the data that refers to the time before the treatment.

'first_tmt'

Uses the data that refers tot the time after the treatment.

'entire'

Uses the complete data of the entire timespan.

Note: This argument is ignored if the experiment set up did not include any treatment or the treatment started right from the beginning.


kueckelj/celltracer documentation built on June 2, 2021, 6:37 a.m.