log_experiment: Create an experiment entry log

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

Description

Create a new text file in the selected folder with all the experiment information passed refered to an experiment, the context and the result.

Usage

log_experiment(..., description = "", tag = "", version = "1.0",
  number = 1, folder = "./logs")

Arguments

...	all the objects and information you want to log. We recommend a ("title", value, "") format.
description	containing the main information of you experiment. E.g: Testing the max_date new feature
tag	an optional tag to separate and organize your logs.
version	a character with the main version of your project. E.g: "1.3" == v1.3 or just "1"
number	of the experiment. E.g: 4 == "v1.3.4"
folder	as character to store the logs

Details

All the information should be passed a ... parameters. Empty characters are considered new lines.

Folder Structure: ./folder ./capitans.log ./version ./exp.tag.version.number.txt

Supports: characters, numbers, data.frames, lists, vectors, ggplots.

See Also

capitan_log

Examples

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

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