Skip to contents

Contributing Guide

Source: CONTRIBUTING.md

Getting Started

git clone git@github.com:GESIS-Methods-Hub/andrew.git

Source Code

The project is structured as a R package. Check the R directory for the R scripts.

How-to

Change *.drawio.png images

draw.io is a open source diagramming software. You can use it online at https://app.diagrams.net/ and download from https://get.diagrams.net/ the desktop version. All *.drawio.png images include a copy of the diagram that draw.io can use to facilitate changes.

Install dependencies with micromamba

Except for Docker and Quarto, all the depenencies cam be installed with mamba. For Docker, follow the steps in https://docs.docker.com/engine/install/ and, for Quarto, download the latest release from https://github.com/quarto-dev/quarto-cli/releases.

Install micromamba following the Mamba Documentation and run

micromamba create -y -n andrew -f conda-lock.yml

or

micromamba create -y -n andrew -f env.yaml

Run tests

devtools::load_all()
devtools::test()

Run package entrypoint

devtools::load_all()
andrew::main(source_dir="demo")

Run package entrypoint with debug message

devtools::load_all()
 logger::log_threshold(logger::DEBUG)
andrew::main(source_dir="demo")

Add new third package dependecy

usethis::use_package("new-third-package-name")

Add new R script

usethis::use_r("new-script")

Add new test

usethis::use_test("new-test")

Skip inclusion of file in built R package

usethis::use_build_ignore("file-to-ignore")

Style R files

styler::style_dir("R")