Skip to content

Commit f200a1b

Browse files
authored
Refactor column naming conventions in GEMINI.md
1 parent 1773fbd commit f200a1b

File tree

1 file changed

+10
-19
lines changed

1 file changed

+10
-19
lines changed

GEMINI.md

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -39,25 +39,16 @@ This document outlines the common coding conventions observed in the `easystats`
3939

4040
## Element / Column names (for returned data frames)
4141

42-
* First letter of the column name is capital, unless (6) applies (*example:* `Parameter`).
43-
44-
* First letter of nouns is capital, unless (6) applies (*example:* `ROPE_Percentage`, `Prior_Scale`).
45-
46-
* Using underscore rather than camelCase to separate words (*example:* `CI_high`).
47-
48-
* Multiple words: common/main part first and adjective/specifier/variational part after, unless (8) applies (*example:* `Median_standardized`, `ROPE_percentage`).
49-
50-
* Abbreviations: all uppercase (*example:* `ESS`, `MCSE`, `ROPE`).
51-
52-
* Keep conventions for reserved words (*example:* `p`, `pd`, `Rhat`).
53-
54-
* Adjectives / verbs: all lower case, unless (1) applies (*example:* `high` or `low` in `CI_high` or `CI_low`).
55-
56-
* In case of multiple occurrences of column names that indicate the same measure or content (like `CI_low` or `SE`), the common part is appended as suffix to the context specific part (*example:* `CI_low` and `Eta2_partial_CI_low`, and **not** `CI_low` and `CI_low_Eta2_partial`).
57-
58-
* The "squared" term in column names that refers to "common" statistics (`Eta2`, `Chi2`, `Omega2`, ...) should be written as `2`, not `sq`, `squared` or `pétit-deux` (*example:* `Chi2`, and **not** `Chisq`, `Eta2`, and **not** `Eta_squared`). This rule does **not** apply to function names.
59-
60-
* Converting between "easystats" style and "broom" style can be done with `insight::standardize_names()`.
42+
1) First letter of the column name is capital, unless (6) applies (*example:* `Parameter`).
43+
2) First letter of nouns is capital, unless (6) applies (*example:* `ROPE_Percentage`, `Prior_Scale`).
44+
3) Using underscore rather than camelCase to separate words (*example:* `CI_high`).
45+
4) Multiple words: common/main part first and adjective/specifier/variational part after, unless (8) applies (*example:* `Median_standardized`, `ROPE_percentage`).
46+
5) Abbreviations: all uppercase (*example:* `ESS`, `MCSE`, `ROPE`).
47+
6) Keep conventions for reserved words (*example:* `p`, `pd`, `Rhat`).
48+
7) Adjectives / verbs: all lower case, unless (1) applies (*example:* `high` or `low` in `CI_high` or `CI_low`).
49+
8) In case of multiple occurrences of column names that indicate the same measure or content (like `CI_low` or `SE`), the common part is appended as suffix to the context specific part (*example:* `CI_low` and `Eta2_partial_CI_low`, and **not** `CI_low` and `CI_low_Eta2_partial`).
50+
9) The "squared" term in column names that refers to "common" statistics (`Eta2`, `Chi2`, `Omega2`, ...) should be written as `2`, not `sq`, `squared` or `pétit-deux` (*example:* `Chi2`, and **not** `Chisq`, `Eta2`, and **not** `Eta_squared`). This rule does **not** apply to function names.
51+
10) Converting between "easystats" style and "broom" style can be done with `insight::standardize_names()`.
6152

6253
## Documentation (roxygen2)
6354

0 commit comments

Comments
 (0)