im_on_fire: Set up everything needed to start an analysis

View source: R/im_on_fire.R

im_on_fireR Documentation

Set up everything needed to start an analysis

Description

This function will do necessary steps to set up an environment for an analysis Basically, it sets up a working directory, creates options variable in global environment, creates folders and downloads template file for officer package.

Usage

im_on_fire()

Details

You should really start with this

Value

environment setup and variables:

  • working directory

  • directories in working directory: Data, Pictures, Templates, Outputs

  • downloaded file template.docx into Templates directory

  • global variable in r.flex.opts environment doc based on template.docx to be used with officer

  • r.flex.opts environment which is used in functions for options:

    • lang - language - defaults to "hr", can be changed to "en"

    • d.p - decimal point type - defaults to ",", can be changed to "."

    • lead.zero (boolean) - will the leading zero be shown in numbers. e.g. 0.05 or .05. Defaults to TRUE

    • p.type - how do you show p values. Options are

      • "<>" - default - they will be shown as compared to critical points (<0.05, <0.01, <0.001)

      • "exact" - shown as exact values

      • "star" - shown as stars as compared to critical points (<0.05, 0.01, 0.001)

    • tab.caption (boolean) - should table captions be put in word file. Defaults to TRUE


mrajter/rajter.flex documentation built on July 30, 2024, 1:31 a.m.