README.md

In iuga/starlog: R library to entry log records to track the experiments you run, the context and its results.

StarLog

Overview

R library to entry log records to track the experiments you run, the context and its results. A starlog or log entry was a recording entered into a starship computer record for posterity in Star Trek.

Installation

#install.packages("devtools")
devtools::install_github("iuga/starlog")

Usage

The following code at the end of your experiment:

library(starlog)

log_experiment(
    # Entry log information:
    description = "First experiment using XGBoost",
    tag = 'ml', version='1.0', number = 1,
    # Log all the needed information:
    "Final AUC:", 0.789, ""
)

It's going to create these files:

./logs/
   ./capitan.log
   ./1.0/
     ./exp.ml.1.0.1.txt
     ...

With the following content:

Experiment #1 (v:1.0-ml)
StarDate: 2018-08-04 12:46:55

Capitan's log:
First experiment using XGBoost

Final AUC:
0.789

and append a entry log in the masters capitan log with the summarized content:

• Experiment v:1.0.1 - Stardate: 2018-08-04 12:49:21
    First experiment using XGBoost

iuga/starlog documentation built on May 20, 2019, 8:01 p.m.