Giters

npp97 / easystats

:milky_way: The easyverse

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

easystats







The aim of easystats is to provide a unifying and consistent framework to tame, discipline and harness the scary R statistics and their pesky models.

Installation

The whole easystats suite can be installed at once with the following:

install.packages("devtools")
devtools::install_github("easystats/easystats")
library("easystats")

Features

Dependencies

Taking all packages from the easystats project into account, we have following package dependencies.

The see package is one of our high-level packages that is responsible for plotting and creating figures. Thus, it increases package dependencies by a substantial amount. Just taking the core packages into consideration, you see that the easystats packages are indeed small and lightweight.

Downloads

Trend

Cumulative downloads

Convention of code-style

Following conventions apply to the easystats-ecosystem, to ensure that function and argument names as well as element names for return-values follow a consistent pattern across all packages.

Importing other packages

  • No full import, only selective import of functions
  • Use base-R wherever possible (reduce dependencies)
  • Make sure R-version requirements are not too strict

Helper-functions

  • Own re-implementation of helper-functions, if it’s not too much effort (e.g. I typically use own functions to check if a string starts / ends with a pattern, or if an object (list, data frame) contains an element with a given name (like tibble::has_name()), to reduce dependencies.

Function names

  • Lower case, underscore separated if more than one verb
  • Common prefix for functions that focus on specific “tasks” or workflows (e.g. insight, get_*() to get data, find_*() to find information, or performance, performance_*() to compute measures of model quality, check_*() to check model assumptions…)
  • Internal functions (that are not exported, like the previously mentined helper-functions) should always start with a . (e.g., .do_some_internal_stuff()).

Argument names

  • lower case, underscore separated if more than one verb

Element / Column names (for returned data frames)

  1. First letter of the column name is capital, unless (6) applies (example: Parameter)
  2. First letter of nouns is capital, unless (6) applies (example: ROPE_Percentage, Prior_Scale)
  3. Using underscore rather than camelCase to separate words (example: CI_high)
  4. Multiple words: common/main part first and adjective/specifier/variational part after (example: Median_standardized, ROPE_percentage)
  5. Abbreviations: all uppercase (example: ESS, MCSE, ROPE)
  6. Keep conventions for reserved words (example: p, pd, Rhat)
  7. Adjectives / verbs: all lower case, unless (1) applies (example: high or low in CI_high or CI_low)

List of functions

About

:milky_way: The easyverse

License:GNU General Public License v3.0

Languages

Language:R 62.9%Language:TeX 37.1%