# subtitle_template

0th

Percentile

##### Template for subtitles with statistical details for tests with a single parameter (e.g., t, chi-squared, etc.)

Template for subtitles with statistical details for tests with a single parameter (e.g., t, chi-squared, etc.)

##### Usage
subtitle_template(no.parameters, stat.title = NULL, statistic.text,
statistic, parameter = NULL, parameter2 = NULL, p.value,
effsize.text, effsize.estimate, effsize.LL, effsize.UL, n,
conf.level = 0.95, k = 3L, k.parameter = 0L)
##### Arguments
no.parameters

An integer that specifies that the number of parameters for the statistical test. Can be 0 for non-parametric tests, 1 for tests based on t-statistic or chi-squared statistic, 2 for tests based on F-statistic.

stat.title

A character describing the test being run, which will be added as a prefix in the subtitle. The default is NULL. An example of a stat.title argument will be something like "Student's t-test: ".

statistic.text

A character that specifies the relevant test statistic. For example, for tests with t-statistic, statistic.text = "t". If you want to use plotmath, you will have to quote the argument (e.g., quote(italic("t"))).

statistic

The numeric value of a statistic.

parameter

The numeric value of a parameter being modeled (often degrees of freedom for the test). Default is NULL to accommodate non-parametric tests.

parameter2

Relevant only if the statistic in question has two degrees of freedom (default: NULL).

p.value

The two-sided p-value associated with the observed statistic.

effsize.text

A character that specifies the relevant effect size. For example, for Cohen's d statistic, effsize.text = "d". If you want to use plotmath, you will have to quote the argument (e.g., quote(italic("d"))).

effsize.estimate, effsize.LL, effsize.UL

The estimated value of the effect size, its lower bound, and its upper.

n

An integer specifying the sample size used for the test.

conf.level

Scalar between 0 and 1. If unspecified, the defaults return 95% lower and upper confidence intervals (0.95).

k

Number of decimal places to display (default: 3).

k.parameter

Number of decimal places to display for the parameter (default: 0).

##### Aliases
• subtitle_template
##### Examples
# NOT RUN {
set.seed(123)

# subtitle for *t*-statistic with Cohen's *d* as effect size
ggstatsplot::subtitle_template(
no.parameters = 1L,
statistic.text = quote(italic("t")),
statistic = 5.494,
parameter = 29.234,
p.value = 0.00001,
effsize.text = quote(italic("d")),
effsize.estimate = -1.980,
effsize.LL = -2.873,
effsize.UL = -1.088,
n = 32L,
conf.level = 0.95,
k = 3L,
k.parameter = 3L
)
# }

Documentation reproduced from package ggstatsplot, version 0.0.10, License: GPL-3 | file LICENSE

### Community examples

Looks like there are no examples yet.
{"ft_lang_label":"__label__en","ft_lang_prob":0.5730571,"math_prob":0.97245014,"size":2571,"snap":"2020-10-2020-16","text_gpt3_token_len":681,"char_repetition_ratio":0.16595247,"word_repetition_ratio":0.17847769,"special_character_ratio":0.26760015,"punctuation_ratio":0.23486239,"nsfw_num_words":0,"has_unicode_error":false,"math_prob_llama3":0.98612744,"pos_list":[0],"im_url_duplicate_count":[null],"WARC_HEADER":"{\"WARC-Type\":\"response\",\"WARC-Date\":\"2020-02-19T14:14:31Z\",\"WARC-Record-ID\":\"<urn:uuid:90600366-ddab-483b-8e8b-a70d89eb3c58>\",\"Content-Length\":\"16200\",\"Content-Type\":\"application/http; msgtype=response\",\"WARC-Warcinfo-ID\":\"<urn:uuid:2fca20f7-d02d-49c2-be23-86e555cf921d>\",\"WARC-Concurrent-To\":\"<urn:uuid:efc1d0d6-6d85-4192-87fb-6ea5c832ac8f>\",\"WARC-IP-Address\":\"3.226.88.111\",\"WARC-Target-URI\":\"https://www.rdocumentation.org/packages/ggstatsplot/versions/0.0.10/topics/subtitle_template\",\"WARC-Payload-Digest\":\"sha1:BQG42QFEBULFMBGHVZQ4YP2ZOVKHYNBQ\",\"WARC-Block-Digest\":\"sha1:TMOXPKVD5MUAQDBRN3SVKGBK745NF7WN\",\"WARC-Identified-Payload-Type\":\"text/html\",\"warc_filename\":\"/cc_download/warc_2020/CC-MAIN-2020-10/CC-MAIN-2020-10_segments_1581875144150.61_warc_CC-MAIN-20200219122958-20200219152958-00253.warc.gz\"}"}