forked from pharmaverse/logrx
-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
45 lines (32 loc) · 2.83 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/",
out.width = "100%"
)
```
# timber <img src="man/figures/logo.png" align="right" alt="" width="120" />
<!-- badges: start -->
[](https://github.com/atorus-research/timber/actions?workflow=R-CMD-check)
[<img src="https://img.shields.io/codecov/c/github/atorus-research/timber">](https://codecov.io/gh/atorus-research/tplyr)
[<img src="https://img.shields.io/badge/License-MIT-blue.svg">](https://github.com/atorus-research/timber/blob/master/LICENSE.md)
[](https://lifecycle.r-lib.org/articles/stages.html#experimental-1)
<!-- badges: end -->
The goal of timber is to facilitate logging in a clinical environment with the goal of making code easily traceable and reproducible.
## Installation
This package is still in development and currently is only available from GitHub. To install the development version run the following:
```{r, eval = FALSE}
devtools::install_github("atorus-research/timber")
```
## What is ```timber```?
While many packages to facilitate the logging of code already exist in the R ecosystem, it is hard to find a solution that works well for clinical programming applications. Many logging implementations are more implicit and rely on user input to create the log for the execution of a script. While this is useful for logging specific events of an application, in clinical programming a log has a set purpose.
```timber``` is built around the concept of creating a log for the execution of an R script that provides an overview of what happened as well as the environment that it happened in. We set out to create a flexible logging utility that could provide the necessary information to anyone reviewing the code execution so they can recreate the execution environment and run the code for themselves. ```timber``` is purpose-built for the needs of clinical programming to capture necessary elements of the environment and execution to be able to create a complete view of the program execution.
## Using timber
```timber``` can be used in a file or through scripting. More information on how to use ```timber``` can be found in `vignette("timber")`
## Future development
While this development version has been released, the development team is still making improvements to the package. This release is intended to give access to the core functionality of ```timber``` while it is still being developed. While the main functions and functionality have already been created, there are still many behind the scenes items that need to be addressed.