ANY-maze Help > The ANY-maze reference > The File page > Creating new experiments > Experiment design files

Experiment design files

Introduction

Experiment design files provide a mechanism by which you can predefine an experiment and then create it with a single action. This can be useful if the person who will create the experiment is not the same person who will perform it. The 'creator' can specify all the details of the experiment within the Experiment design file, and the 'performer' then just has to load the design file and run the experiment.

 Creating an Experiment design file 
 Using an Experiment design file  

Creating an Experiment design file

Experiment design files are just text files and can be created using any text editor, such as Notepad in Windows.

The file has a specific, although simple format: The first line must contain the text '[ANY-maze]' (without the quotation marks). Subsequent lines contain a series of settings, one per line, in any order. Each setting consists of a name followed by an equals sign, followed by a value. The names of the settings are not case sensitive, nor are the values. Some of the settings are required, but most are optional. For example:

  

[ANY-maze]

Protocol          = C:\Experiments\ANY-maze protocols\watermaze.szp

ExperimentTitle   = Water-maze test of drug X at three concentrations

ExperimentFile    = C:\Experiments\ANY-maze experiments\Test of Drug X.szd

AnimalList        = C:\Experiments\ANY-maze experiments\Test of Drug X - animals.csv

LockProtocolEdits = Y

The full list of Experiment design file settings is:

Protocol(Required) The full path and name of the protocol file that will be used by the experiment. For example: 'C:\Experiments\ANY-maze protocols\watermaze.szp'
LockProtocolEdits(Optional) Y or 1 to prevent the protocol from being edited by anyone other than an administrator. N or 0 to allow anyone to edit the protocol. If this setting is not included then anyone will be able to edit the protocol.
ExperimentTitle(Optional) The title of the experiment. This will be written to the experiment title field on the Experiment page. If no title is specified then the experiment simply won't have a title.
ExperimentFile(Optional) The full path and name of the experiment file to be created. For example: 'C:\Experiments\ANY-maze experiments\Test of Drug X.szd'. If an experiment file is specified then the experiment will be saved to this file immediately after it has been created. If no experiment file is specified then the user will need to specify the experiment file path and name when he first saves the file. In this case, if an 'ExperimentTitle' has been specified then it will be suggested as the file name.
AnimalList(Optional) The full path and name of a file containing a list of the animals to be tested in the experiment. This file should be formatted in exactly the same way as an animal import file; full details of this format can be found here.
DisallowUndoLastTest(Optional) Y or 1 to prevent the user from undoing tests, N or 0 to allow the user to undo tests. If this setting is not specified, the user will be able to undo tests.
AlwaysSaveTestResults(Optional) Y or 1 to force test results to always be saved (if the user ends the test manually). N or 0 to allow the user to choose whether or not to save the test results. If this settings is not specified, the user will be able to choose whether or not to save the test results.
BarcodeVerification(Optional) Y or 1 to force animal IDs to be verified by scanning the animal's barcode or chip before every test. N or 0 to not require animal IDs to be verified in this way. If this setting is not specified, the animal ID will not need to verified.
BarcodePrefix(Optional) If 'BarcodeVerification' is being used, then this specifies the character code of the barcode prefix character used by the barcode or chip scanner. If this setting is not specified then a default barcode prefix of character code 3 (ASCII code ETX) will be used. Note that this is different to the default that is normally used by ANY-maze, which is 2 (ASCII code STX). If 'BarcodeVerification' is not being used then this setting is ignored.
BarcodeSuffixThe suffix character for barcodes If 'BarcodeVerification' is being used, then this specifies the character code of the barcode suffix character used by the barcode or chip scanner. If this setting is not specified then a default barcode suffix of character code 3 (ASCII code ETX) will be used. Note that this is different to the default that is normally used by ANY-maze, which is 4 (ASCII code EOT). If 'BarcodeVerification' is not being used then this setting is ignored.

Below is an example of an Experiment design file which uses every setting:

[ANY-maze]

Protocol              = C:\Experiments\ANY-maze protocols\watermaze.szp

LockProtocolEdits     = Y

ExperimentTitle       = Water-maze test of drug X at three concentrations

ExperimentFile        = C:\Experiments\ANY-maze experiments\Test of Drug X.szd

AnimalList            = C:\Experiments\ANY-maze experiments\Test of Drug X - animals.csv

DisallowUndoLastTest  = N

AlwaysSaveTestResults = Y

BarcodeVerification   = Y

BarcodePrefix         = 2

BarcodeSuffix         = 3

Using an Experiment design file

To use an experiment design file, you just need to open the file in the same way as you'd normally open an experiment file; for example, you could select Open experiment on the File page, change the type of file on the file open window to 'Experiment design file' and then select the file. Alternatively, you could drag an Experiment design file into ANY-maze, or you could simply double click on an Experiment design file from within Windows. In all cases the Experiment design file will be opened.

When you open a design file ANY-maze will create an experiment based on the design file settings. If during this process something goes wrong, for example, the protocol file specified doesn't exist, or the Animal list contains an invalid entry, then a message will be displayed explaining what the problem is and no experiment will be created.

After successfully creating an experiment from the design file, ANY-maze will note that the design file has been used and will then prevent it from being used again. In other words, you can only create an experiment from a design file once. If you try to use it again, a message will be displayed stating this and detailing who used the design file and when.

See also:

 Importing animals 
 Undoing a performed test 
 Choosing whether results will always be saved when a test is ended manually 
 Choosing whether or not to verify animal IDs before each test 
 Barcode readers or chip scanners that can be used to verify animal IDs 

© Copyright 2003-2026 Stoelting Co. All rights reserved

ANY-maze help topic T0057