BORIS App Documentation. Release latest

Transcription

1 BORIS App Documentation Release latest Jul 21, 2017

2

3 Contents 1 Legal 3 2 Introduction 5 3 Installation Install the Kivy Launcher Install BORIS App on your Android device Use Launch the BORIS App Transfer your project from BORIS to BORIS App Open the project Start a new observation Select the focal subject State events Modifiers selection Stop the observation Sending observation to BORIS Limitations 27 i

4 ii

5 Author Olivier Friard version Be careful! This version must be considered as an ALPHA version only for testing Contents BORIS App user guide Legal Introduction Installation Use Limitations Contents 1

6 2 Contents

7 CHAPTER 1 Legal Copyright 2017 Olivier Friard - Marco Gamba BORIS App is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or any later version. BORIS App is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. 3

8 4 Chapter 1. Legal

9 CHAPTER 2 Introduction BORIS App is an event logging app for live observations. BORIS App is designed to be used with BORIS (Behavioral Observation Research Interactive Software, v. 4+) and share with it the project format. BORIS App run on Android (2.2+). You will have to install the Kivy Launcher 5

10 6 Chapter 2. Introduction

11 CHAPTER 3 Installation Install the Kivy Launcher BORIS App is developped in Python using Kivy as user interface. You must install the Kivy Launcher on your Android device before installing BORIS App. You can run Kivy applications on Android, on any device with Android Install BORIS App on your Android device The BORIS App is available on the BORIS App GitHub repository: releases Extract the zip (or tar.gz) archive on your computer and copy the extracted directory (BORIS-App-VERSION) to /sdcard/kivy/. For example: /sdcard/kivy/boris-app-version If the /sdcard/kivy directory does not exist on your Android device you must create it 7

12 8 Chapter 3. Installation

13 CHAPTER 4 Use Launch the BORIS App Start Kivy Launcher 9

14 Select BORIS App, you should see the following screen: 10 Chapter 4. Use

15 Transfer your project from BORIS to BORIS App This operation requires an internet connexion. Launch BORIS on your desktop or laptop computer (see This version of BORIS App works only with the v. 4+ of BORIS Desktop. The BORIS user guide is available at boris.readthedocs.io Open the project containing the ethogram you want to transfer to BORIS App Start the project server (File > Project server) On BORIS App press the Download project button 4.2. Transfer your project from BORIS to BORIS App 11

16 Check the Download from BORIS checkbox (default) Input the URL shown in BORIS on Desktop/Laptop computer (for example :33149) without spaces Press the Download project button You should receive the project from BORIS Desktop and obtain the following message: 12 Chapter 4. Use

17 The BORIS desktop should show you this message: Open the project Press the Open project button Select the new downloaded project Press the Open project button BORIS App will show a summary of the selected project: 4.3. Open the project 13

18 Start a new observation Press the New observation button 14 Chapter 4. Use

19 Input an Observation id (mandatory, this id must be unique in your project) Change the date (optional, default: current date time) Input a description for your observation (optional) If independent variables are defined, click on the Independent var button and fill the value for each variable Start a new observation 15

20 Press the Start observation button You will obtain a screen with buttons corresponding to behaviors defined in your project. You can press it to code behaviors. The event time will be recorded in your observation. 16 Chapter 4. Use

21 If behavioral categories are defined in your project, the behaviors will be grouped by category and buttons will be colored Start a new observation 17

22 Select the focal subject Press the Select focal subject button Select the focal subject. If the focal subject is already selected, the subject will be deselected. 18 Chapter 4. Use

23 The focal subject will be show in the green button (at left bottom) Select the focal subject 19

24 State events If you press on a state event, the corresponding behavior button will be highlighted in red until you press it again to stop the state event. 20 Chapter 4. Use

25 Modifiers selection If modifiers are defined for the triggered behavior, BORIS App will show the modifiers page. They are 3 types of modifiers: Single item selection from a list Multiple items selection from a list Numerical Various sets of modifiers can be defined for a behavior. BORIS App will show a page with all sets of modifiers defined for the current behavior Modifiers selection 21

26 Example for one set of modifiers (single item). 22 Chapter 4. Use

27 Example for one set of modifiers (multiple items). 2 modifiers are selected Modifiers selection 23

28 Example for 2 sets of modifiers (single item) Stop the observation Press the Stop observation red button. Confirm that you want to quit. The observation will be saved in the current project. Sending observation to BORIS You can send an observation back to BORIS running on your desktop/laptop computer (requires an internet connexion). Start the project Server on BORIS desktop (File > Project server) On BORIS App, open the project containing the observation to send. Press the Send observation button Select the observation you want to send in the observations list 24 Chapter 4. Use

29 Input the URL of project server 4.9. Sending observation to BORIS 25

30 Press the Send observation button The observation will be added to the current project of BORIS desktop. If an observation with same id already exists BORIS will ask you for renaming it or overwriting it. 26 Chapter 4. Use

31 CHAPTER 5 Limitations These limitations should be fixed in next releases. BORIS App can not handle independent variables defined as set of values 27