folderstructure

Documentation

Overview

Package folderstructure provides functions for the folder strucure of output data

Index

• Variables
• func FileSystemEscape(input string) string
• func GetAndCreateOutputFolder(exp experiment.Experiment, subfolders ...string) (string, error)
• func GetOutputFolder(exp experiment.Experiment, subfolders ...string) string
• func MayCreatePath(path string) bool

Variables

var OutputFolderName = "output"

The name of the (top level) output folder

var OverwriteExisting bool = false

OverwriteExisting determines whether existing files should be overwritten (true) or left untouched (false)

Functions

func FileSystemEscape

func FileSystemEscape(input string) string

FileSystemEscape removes all illegal characters from the input string so that it's safe to use for file system operations

func GetAndCreateOutputFolder

func GetAndCreateOutputFolder(exp experiment.Experiment, subfolders ...string) (string, error)

GetOutputFolder returns the relative path of the output folder and creates the folder if it does not exist

func GetOutputFolder

func GetOutputFolder(exp experiment.Experiment, subfolders ...string) string

GetOutputFolder returns the relative path of the output folder

func MayCreatePath

func MayCreatePath(path string) bool

MayCreateFile returns whether a file may be created/overwritten or should not be touched.