When this functionality is used in the Analyses sheet, you can use the drop-down menu in cell A1 to choose whether you want to add rows to all tables or just one in particular.
When this functionality is used in the Analyses sheet, you can use the drop-down menu in cell A1 to choose whether you want to remove empty rows to all tables or just one in particular.
At the end, it will open a popup window with information on the update of the translation table.
Go to the Translation sheet for more information on translations.
@@ -402,7 +406,7 @@
The setup file comes with a series of checks on its content to help you debug your dictionary. After adding major components to your setup file, or before compiling a linelist with the designer, you can should click on the button “Check current setup for errors” to see any errors in the “__checkRep” sheet.
There is a table for each sheet or section (in the case of analyses), with the following three columns:
“Incoherences Type” preceded by the name of the sheet,
“Where?”, which shows the name of the sheet or section and the line where the incoherence is located,
“Details”, which gives details of the incoherence.
Incoherences Type preceded by the name of the sheet,
Where?, which shows the name of the sheet or section and the line where the incoherence is located,
Details, which gives details of the incoherence.
There are several types information that could appear in the Incoherence column:
Use the dropdown to change the language of the designer interface. Available languages: English, French, Arabic, Spanish and Portuguese.
+Use the dropdown menu to change the language of the designer interface. Available languages: English, French, Arabic, Spanish and Portuguese.
The import of the geobase deos not affect the data already entered in the linelist, it only fills the modalities offered by dropdown menus. If data is already present in the linelist and the new geobase has different levels, you need to correct them yourselves.
+The import of the geobase does not affect the data already entered in the linelist, it only fills the modalities offered by dropdown menus. If data is already present in the linelist and the new geobase has different levels, you need to correct them yourselves.
Go here to learn how to download a geobase.
@@ -699,7 +702,14 @@The regular exports buttons are available in the “Export section” of the ribbon, and the “Export for migration” is available in the Advanced section of the ribbon.
-
#### Export data
OutbreakTools linelists have the feature to export data in a separated excel file, to share with partners or perform more advance analyses. The characteristics of the exports (which variables, anonymisation or not, password protected or not etc.) are pre-defined in the setup file that is used to generate the linelist.
While Epicentre linelists should have at minima be an “Anonymous export for MSF” button, the other available exports differ between linelists created.
To export data, click on the “Export Data” button, which opens a popup window, with several options. At the top, you will see buttons for different exports. After clicking on the desired export, a window pops-up for saving the export. If “Export Filtered Data” is selected, a confirmation message will pop-up first to ask you whether this is what you really want.
@@ -718,6 +728,7 @@Click on the button “Generate new password” to change the password used by default.
+You can export all the tables from the analysis sheets in one document by using the “Export the analysis sheets” button and selecting the directory where you want to save them.
@@ -784,7 +795,7 @@
After selecting the options and clicking on “Export”, a window pops-up for saving the export. Select the folder and click on “OK”. Once finished a message appears to ask if you want to close the window.
diff --git a/search.json b/search.json index 87aa5ac..8e35c53 100644 --- a/search.json +++ b/search.json @@ -655,21 +655,21 @@ "href": "reference/ribbons.html#sec-setup-ribbon", "title": "Ribbons", "section": "Setup", - "text": "Setup\n\n\n\n\n\n\nFigure 1: OutbreakTools tab in the setup file\n\n\n\n\nTable management\nThe buttons of this section provide action on tables within the setup: main table on the Dictionary sheet, table for choices, table for exports, tables for analyses etc.\n\n\n\nOutbreakTools tab in the designer\n\n\n\nAdd rows\nThis button insert rows at the bottom of the table in the current sheet.\nWhen this functionality is used in the Analyses sheet, you can use the drop-down menu in cell A1 to choose whether you want to add rows to all tables or just one in particular.\n\n\n\n\n\n\n\nResize table in the current sheet\nThis button remove empty rows (whether at the end or in the middle).\nWhen this functionality is used in the Analyses sheet, you can use the drop-down menu in cell A1 to choose whether you want to remove empty rows to all tables or just one in particular.\n\n\n\n\n\n\n\nRemove filters\nThis button clears filters. It is usefull if you have applied Excel filters in several columns, no need to track them all one by one, just clear them in one go.\n\n\n\nTranslation\nThis section provides functionalities for the Translation sheet.\n\n\n\nOutbreakTools tab in the designer\n\n\n\nAdd language\nThis button adds a new column to translations sheet, to add a new linelist language.\n\nFill the name of the language in the box\nClick on the button: it will add a new empty column on the right of the columns already present.\n\nMore information to add a language\n\n\nUpdate translation table\nClick on this button to update the whole translation table. You can use it whether there is only one language or more.\nThe script will scrap the setup and import all the fields to be translated into the table, listed in alphabetical order.\nAt the end, it will open a popup window with information on the update of the translation table.\n\n\n\n\n\nGo to the Translation sheet for more information on translations.\n\n\n\nImport\nThese buttons allow to import data into an empty setup.\n\n\n\nOutbreakTools tab in the designer\n\n\n\nImport data from another setup\nUse this button to migrate data from one setup file to another empty setup file1.\n\nClick on the button; it opens a popup window\nClick on the “Load another setup file” button. It will open a window to select the file to import data from.\nSelect what to import from the original by ticking the boxes.\nDecide if you want to run a checkup of the setup file after import by ticking the box or not\nClick on the “Import” button and wait.\n\n\n\n\nOutbreakTools tab in the designer\n\n\n\n\n\n\n\n\nNote\n\n\n\nIf you are migrating a setup to a new setup file, you should check all boxes to import everything.\nYou can run the coherence checks now, or do it at a later stage with the Check setup button\n\n\n\n\nImport from disease (in developpment)\nThis button is used to import a “disease setup” from a disease Master file. This file is being piloted for Epinetwork discussions.\n\n\n\nAdvanced\n\n\n\nOutbreakTools tab in the designer\n\n\n\nCheck current setup for errors\nThe setup file comes with a series of checks on its content to help you debug your dictionary. After adding major components to your setup file, or before compiling a linelist with the designer, you can should click on the button “Check current setup for errors” to see any errors in the “__checkRep” sheet.\nThere is a table for each sheet or section (in the case of analyses), with the following three columns:\n\n“Incoherences Type” preceded by the name of the sheet,\n“Where?”, which shows the name of the sheet or section and the line where the incoherence is located,\n“Details”, which gives details of the incoherence.\n\nThere are several types information that could appear in the Incoherence column:\n\nInfo (in grey): this is not an inconsistency, but simply a piece of information about something that will not block the compilation of the linelist.\nWarning (in yellow): these are problems that need to be fixed because there is a real inconsistency or problem. It could be an error in a formula, for example.2\nNote (in blue): this is something that has been defined in the setup, but will not be applied, and is therefore not blocking. For example, in the analyses, certain choices are contradictory by design, such as the display of percentages, which is not authorised when you choose to invert the display of the table (horizontal display instead of vertical).\n\n\n\n\n\n\n\n\nClear data in current setup\nThis feature allows you to delete all the data entered in the setup file.\n\nClick on the button; it opens a popup window to decide which part of the setup you want to clear\nTick boxes to select sheets to clean\nClick on the “Clear” button. It will open a window to ask you if you are very sure.\n\n\n\n\n\n\n\n\n\nDev\nThe dev tab is for the OBT developer and you can ignore it." + "text": "Setup\n\n\n\n\n\n\nFigure 1: OutbreakTools tab in the setup file\n\n\n\n\nTable management\nThe buttons of this section provide action on tables within the setup: main table on the Dictionary sheet, table for choices, table for exports, tables for analyses etc.\n\n\n\nTable management section\n\n\n\nAdd rows\nThis button insert rows at the bottom of the table in the current sheet.\nWhen this functionality is used in the Analyses sheet, you can use the drop-down menu in cell A1 to choose whether you want to add rows to all tables or just one in particular.\n\n\n\nButton to add or remove rows of diffeent analyses tables\n\n\n\n\nResize table in the current sheet\nThis button remove empty rows (whether at the end or in the middle).\nWhen this functionality is used in the Analyses sheet, you can use the drop-down menu in cell A1 to choose whether you want to remove empty rows to all tables or just one in particular.\n\n\n\nButton to add or remove rows of diffeent analyses tables\n\n\n\n\nRemove filters\nThis button clears filters. It is usefull if you have applied Excel filters in several columns, no need to track them all one by one, just clear them in one go.\n\n\n\nTranslation\nThis section provides functionalities for the Translation sheet.\n\n\n\nTranslation section\n\n\n\nAdd language\nThis button adds a new column to translations sheet, to add a new linelist language.\n\nFill the name of the language in the box\nClick on the button: it will add a new empty column on the right of the columns already present.\n\nMore information to add a language\n\n\nUpdate translation table\nClick on this button to update the whole translation table. You can use it whether there is only one language or more.\nThe script will scrap the setup and import all the fields to be translated into the table, listed in alphabetical order.\nAt the end, it will open a popup window with information on the update of the translation table.\n\n\n\nMessage of end of translation update\n\n\nGo to the Translation sheet for more information on translations.\n\n\n\nImport\nThese buttons allow to import data into an empty setup.\n\n\n\nImport section\n\n\n\nImport data from another setup\nUse this button to migrate data from one setup file to another empty setup file1.\n\nClick on the button; it opens a popup window\nClick on the “Load another setup file” button. It will open a window to select the file to import data from.\nSelect what to import from the original by ticking the boxes.\nDecide if you want to run a checkup of the setup file after import by ticking the box or not\nClick on the “Import” button and wait.\n\n\n\n\n\n\n\n\n\n\n\n\nNote\n\n\n\nIf you are migrating a setup to a new setup file, you should check all boxes to import everything.\nYou can run the coherence checks now, or do it at a later stage with the Check setup button\n\n\n\n\nImport from disease (in developpment)\nThis button is used to import a “disease setup” from a disease Master file. This file is being piloted for Epinetwork discussions.\n\n\n\nAdvanced\n\n\n\nAdvanced section\n\n\n\nCheck current setup for errors\nThe setup file comes with a series of checks on its content to help you debug your dictionary. After adding major components to your setup file, or before compiling a linelist with the designer, you can should click on the button “Check current setup for errors” to see any errors in the “__checkRep” sheet.\nThere is a table for each sheet or section (in the case of analyses), with the following three columns:\n\nIncoherences Type preceded by the name of the sheet,\nWhere?, which shows the name of the sheet or section and the line where the incoherence is located,\nDetails, which gives details of the incoherence.\n\nThere are several types information that could appear in the Incoherence column:\n\nInfo (in grey): this is not an inconsistency, but simply a piece of information about something that will not block the compilation of the linelist.\nWarning (in yellow): these are problems that need to be fixed because there is a real inconsistency or problem. It could be an error in a formula, for example.2\nNote (in blue): this is something that has been defined in the setup, but will not be applied, and is therefore not blocking. For example, in the analyses, certain choices are contradictory by design, such as the display of percentages, which is not authorised when you choose to invert the display of the table (horizontal display instead of vertical).\n\n\n\n\n\n\n\n\nClear data in current setup\nThis feature allows you to delete all the data entered in the setup file.\n\nClick on the button; it opens a popup window to decide which part of the setup you want to clear\nTick boxes to select sheets to clean\nClick on the “Clear” button. It will open a window to ask you if you are very sure.\n\n\n\n\n\n\n\n\n\nDev\nThe dev tab is for the OBT developer and you can ignore it." }, { "objectID": "reference/ribbons.html#sec-designer-ribbon", "href": "reference/ribbons.html#sec-designer-ribbon", "title": "Ribbons", "section": "Designer", - "text": "Designer\n\n\n\nOutbreakTools tab in the designer\n\n\n\nManage the designer\n\nClear the geobase\nRemove any geobase that was loaded in the designer.\n\n\nClear entries\nRemove all user entered data from fields.\n\n\nLanguage of the designer\nUse the dropdown to change the language of the designer interface. Available languages: English, French, Arabic, Spanish and Portuguese.\n\n\n\nImports\n\nImport translations\nIf the user wishes to modify the linelist interface translations, it is possible to ask for the config file to EpiDS/Yves Amevoin, tweak it and import it with this button.\n\n\nImport passwords\nThe designer is loaded with a pasword table, with private and public keys to protect export if the user want a password-protected export. However, the designer is on Github, in a public repo, so if you compile a linelist that needs a password protection, it is best to ask for the config file to EpiDS/Yves Amevoin and import it using the “Import button”.\n\n\nImport styles\nThe designer comes with two default styles for linelist themes. It is possible to personalise it. To do that, ask for the config file to EpiDS/Yves Amevoin, tweak it and import it with this button." + "text": "Designer\n\n\n\nOutbreakTools tab in the designer\n\n\n\nManage the designer\n\nClear the geobase\nRemove any geobase that was loaded in the designer.\n\n\nClear entries\nRemove all user entered data from fields.\n\n\nLanguage of the designer\nUse the dropdown menu to change the language of the designer interface. Available languages: English, French, Arabic, Spanish and Portuguese.\n\n\n\nImports\n\nImport translations\nIf the user wishes to modify the linelist interface translations, it is possible to ask for the config file to EpiDS/Yves Amevoin, tweak it and import it with this button.\n\n\nImport passwords\nThe designer is loaded with a pasword table, with private and public keys to protect export if the user want a password-protected export. However, the designer is on Github, in a public repo, so if you compile a linelist that needs a password protection, it is best to ask for the config file to EpiDS/Yves Amevoin and import it using the “Import button”.\n\n\nImport styles\nThe designer comes with two default styles for linelist themes. It is possible to personalise it. To do that, ask for the config file to EpiDS/Yves Amevoin, tweak it and import it with this button." }, { "objectID": "reference/ribbons.html#sec-linelist-ribbon", "href": "reference/ribbons.html#sec-linelist-ribbon", "title": "Ribbons", "section": "Linelist", - "text": "Linelist\n\n\n\nOutbreakTools tab in the created linelist\n\n\n\nData table\n\n\n\nButtons acting on data entry tables\n\n\n\nShow / Hide variables\nClicking on the “Show/hide variables” button opens a window listing all the variables in this linelist sheet.\n\n\n\nShow hide button and pop-up window\n\n\nVariable can have three visibility status:\n\nMandatory: variables cannot be hidden with the Show/Hide\nShown: variables are currently visible but can be hidden by ticking “Hide” on the right\nHide: variables are currently hidden but can be made visible by ticking “Show” on the right\n\n\n\n\n\n\n\nTip\n\n\n\nYou can hide all optional variables in one go by clicking on the “Hide all optional variables” button.3\nThe button will change to “Show all optional variables”, to allow the reverse action.\n\n\n\n\nAdd rows\nBy default, the linelist has 200 empty lines. But you can add more when these are filled. Click on the “Add Rows” button to add 200 new empty rows.\n\n\nResize table\nYou can resize the table to remove empty rows at the bottom of the table on the linelist sheet. Click on the “Resize table” button to remove any empty row.\n\n\nClear all filters\nTo remove all the filters at once, click on the “Clear all filters” button. This is useful if you applied filters to several columns scattered left and right of the table and want to reverse to the full view without missing a sneaky filter somewhere.\n\n\nSort the variable\nIf you need to visualize your data by sorting on specific variables (date of notification for example), you need to use the sorting function. Place the cursor in a cell of the column you want to sort (from line 9) and click on the button.\nThe first time you click, you have a message to confirm the action, once you click yes, you cannot undo it. The first time it sorts by ascending order, if you click again, it will sort by descending order.\n\n\nWeek start\nChose the day that starts the week in your country using the “Week start” button. The selected value will be applied to the whole linelist (calculated epiweeks, as well as in the analyses).\nWhen you click on the button, a pop up window appears, where you can select the day of the week. Then close the window.\n\n\nAutofit columns\nUse this button to improve column width so that the columns take less space. The fit takes into account the label, the length of categories of the variable (if any) and the name of the variable (hidden).\n\n\n\n\n\n\nTip\n\n\n\nYou can manually modify the width of columns in the linelist table to adjust to content the way you would do in any Excel file.\n\n\n\n\nGeoHelper\nThe GeoHelper is a popup window that helps you entering geographic data surch as the origin of the patient or the name of the facility (if the “hf” control was used for the variable). It is mostly used to enter data on the patient data sheet, but it is also useful on the Spatio-Temporal analysis sheet.\nTo use it, place your cursor in a “geo” or “hf” column (you can recognise them thanks to the orange headers), in the admin 1 level. Click on the “Geohelper” button, or hit the shortcut Ctrl + Shift + G. It opens a window, with several tabs, depending on whether you are in a “geo” (described by four visible columns) or in “hf” (decribed by one isible column).\nIf you are in a “geo” section, you will have three tabs that you can use to select administrative levels.\n\nCascade: select the admin levels with cascading menus, by selecting one admin level after the other, starting from the highest one.\nSearch: search by typing the name (needs at least 3 letters)\nHistory: quickly find a previous entry entered through the GeoHelper (does not work for data entered using the regular cascading dropdowns).\n\nOnce the location has been found, select it and click on “OK”.\n\n\n\nRefresh analyses\n\n\n\nRefresh analyses button\n\n\nHit the “Refresh analyses” button to update analyses on all analyses sheets in one go. You should use it whenever you entered new data or when you applied filters to existing data and want to see the analyses on this subset of data.4\n\n\nImports\n\n\n\nImports section\n\n\n\nImport data\nThe « Import Data » button allows you to import data in the linelist. This data must be in a special format typically produced by exporting data from another OutbreakTools linelist for the same disease.\nFirst a window opens to select the file to import. Select it and click on “OK”. At the end, a message will inform you of the success and provide a little import report is you wish so. Inspect it to see if there are any unexpected discrepancies (loosing variables should always be investigated!).\n\n\n\n\n\n\nImportant\n\n\n\nThe same button is used whether the data is partial (generated by the regular export button, anonymised or not, with metadata or not), or extensive (generated through the “Export for migration” button, from the Advanced section of the ribbon).\n\n\nIf there is already data in the file, a message will inform you of that fact and ask you what you wish to do. It is possible to append the new data at the bottom of the already present data. This is a handy way to create temporary master linelists, or to gather data entered by two data-encoders.\n\n\n\n\n\n\nWarning\n\n\n\nMake sure the data is not overlapping before importing, as the import will just paste the data at the bottom of the existing data, and you would end up with duplicates to clean.\n\n\n\n\nImport geobase\n“Import geobase” allows you to import a geobase in the linelist. If the current linelist had already a geobase, it will be replaced.\n\n\n\n\n\n\nWarning\n\n\n\nThe import of the geobase deos not affect the data already entered in the linelist, it only fills the modalities offered by dropdown menus. If data is already present in the linelist and the new geobase has different levels, you need to correct them yourselves.\n\n\nGo here to learn how to download a geobase.\n\n\n\nExports\nThe regular exports buttons are available in the “Export section” of the ribbon, and the “Export for migration” is available in the Advanced section of the ribbon.\n #### Export data\nOutbreakTools linelists have the feature to export data in a separated excel file, to share with partners or perform more advance analyses. The characteristics of the exports (which variables, anonymisation or not, password protected or not etc.) are pre-defined in the setup file that is used to generate the linelist.\nWhile Epicentre linelists should have at minima be an “Anonymous export for MSF” button, the other available exports differ between linelists created.\nTo export data, click on the “Export Data” button, which opens a popup window, with several options. At the top, you will see buttons for different exports. After clicking on the desired export, a window pops-up for saving the export. If “Export Filtered Data” is selected, a confirmation message will pop-up first to ask you whether this is what you really want.\nOnce the folder has been selected and after clicking “OK”, a new window opens to confirm the export and, if the export is protected, provide the associated password.\n\n\n\n\n\n\nTip\n\n\n\nIf you forgot the password, click on the “Export Button” again, and then click on the “Show actual private key” to display the password again.\n\n\nClick on the button “Generate new password” to change the password used by default.\n\nExport analyses\nYou can export all the tables from the analysis sheets in one document by using the “Export the analysis sheets” button and selecting the directory where you want to save them.\n\n\n\n\n\n\nWarning\n\n\n\nIf the analysis are made on filtered data, the tables will be exported as such.\n\n\n\n\n\nRegister and Case report form\nYou can print a register directly based on the linelist.\n\n\n\nRegister and case report form section\n\n\nThe features from this category only work if you are on a data entry sheet, otherwise you get an error message.\nClick on “Show register”; it opens a new sheet that contains all the variables from the linelist. On this sheet, you can use the Data Table features can be used just as in the original linelist sheet:\n\n“Add rows” and “Resize table” work exactly the same (except that it adds 10 rows at once)\n“Show/Hide variables” works the same but looks a bit different. Instead of “Show” you can select “print” and the orientation of the header. You can also import the parametrisation of hidden/shown columns from the regular linelist table, or change column width.\n\nYou can rotate all the labels at once by clicking the “Rotate headers” button. You can define the heigh of the row by clicking directly on “Row height”, a pop-up opens where you can define the heigh.\nAll labels are editable.\n\n\n\n\n\n\nTip\n\n\n\nYou should hide all calculted variable, they have no place i a register book\n\n\nOnce customized, you can close the sheet by clicking the red cross, all your modifications are saved.\nOnce ready, you can use the “Print” button to open the print preview view (whether you are on the register sheet or the linelist sheet). All the variables to be printed fit one page (landscape). If you are satisfied, you can print.\n\n\nAdvanced\n\n\n\nAdvanced button and pop-up window\n\n\n\nExport for migration\nThis button exports raw data and metadata for migration to another linelist file.5\nYou can choose to export the patient data, the geobase and the history of the geobase (history list in the GeoHelper), by ticking the matching cases. There are also options to include metadata on the state of hidden/shown columns (to not have to redo the full setup in the new file), and the updated labels of the custom variables, if you used these variables.\n\n\n\nOutbreakTools tab in the created linelist\n\n\nAfter selecting the options and clicking on “Export”, a window pops-up for saving the export. Select the folder and click on “OK”. Once finished a message appears to ask if you want to close the window.\nThe export creates three files:\n\na file containing the data and all sort of metadata\na file containing the geobase that is currently in the linelist, as well as the history from the GeoHelper\na file containing only the GeoHelper history (in case you want to upgrade to a new version of the geobase but wished to keep your GeoHelper history)\n\n\n\nImport geobase history\nThis button allows you to import a file containing the history of the geobase (such a file was created by exporting the data from migration, see above).\n\n\nLast Import Report\nThe button allows you to display the report from the last import made.\n\n\nDelete data or geobase history\nThis are a dangerous buttons that allows you to delete data or geobase history from the linelist.\n“Delete all data” allows you to remove all the data you entered from the workbook. After clicking, you will have a warning message. To confirm the deletion, you will need to enter the full name of the file.\n“Delete geobase history” allows you to empty the table with the geobase history so the list of suggestion of the history method from the GeoHelper will be empty.\n\n\nRestore the state of hidden columns\nThis button allows you to restore the state of hidden columns (i.e. hide them all again) if, for any reasons these columns had been shown.\nNote that hidden columns are not supposed to be shown, and the user can thus not modify their visibility state from the regular Show/Hide variables button, hence this button." + "text": "Linelist\n\n\n\nOutbreakTools tab in the created linelist\n\n\n\nData table\n\n\n\nButtons acting on data entry tables\n\n\n\nShow / Hide variables\nClicking on the “Show/hide variables” button opens a window listing all the variables in this linelist sheet.\n\n\n\nShow hide button and pop-up window\n\n\nVariable can have three visibility status:\n\nMandatory: variables cannot be hidden with the Show/Hide\nShown: variables are currently visible but can be hidden by ticking “Hide” on the right\nHide: variables are currently hidden but can be made visible by ticking “Show” on the right\n\n\n\n\n\n\n\nTip\n\n\n\nYou can hide all optional variables in one go by clicking on the “Hide all optional variables” button.3\nThe button will change to “Show all optional variables”, to allow the reverse action.\n\n\n\n\nAdd rows\nBy default, the linelist has 200 empty lines. But you can add more when these are filled. Click on the “Add Rows” button to add 200 new empty rows.\n\n\nResize table\nYou can resize the table to remove empty rows at the bottom of the table on the linelist sheet. Click on the “Resize table” button to remove any empty row.\n\n\nClear all filters\nTo remove all the filters at once, click on the “Clear all filters” button. This is useful if you applied filters to several columns scattered left and right of the table and want to reverse to the full view without missing a sneaky filter somewhere.\n\n\nSort the variable\nIf you need to visualize your data by sorting on specific variables (date of notification for example), you need to use the sorting function. Place the cursor in a cell of the column you want to sort (from line 9) and click on the button.\nThe first time you click, you have a message to confirm the action, once you click yes, you cannot undo it. The first time it sorts by ascending order, if you click again, it will sort by descending order.\n\n\nWeek start\nChose the day that starts the week in your country using the “Week start” button. The selected value will be applied to the whole linelist (calculated epiweeks, as well as in the analyses).\nWhen you click on the button, a pop up window appears, where you can select the day of the week. Then close the window.\n\n\nAutofit columns\nUse this button to improve column width so that the columns take less space. The fit takes into account the label, the length of categories of the variable (if any) and the name of the variable (hidden).\n\n\n\n\n\n\nTip\n\n\n\nYou can manually modify the width of columns in the linelist table to adjust to content the way you would do in any Excel file.\n\n\n\n\nGeoHelper\nThe GeoHelper is a popup window that helps you entering geographic data surch as the origin of the patient or the name of the facility (if the “hf” control was used for the variable). It is mostly used to enter data on the patient data sheet, but it is also useful on the Spatio-Temporal analysis sheet.\nTo use it, place your cursor in a “geo” or “hf” column (you can recognise them thanks to the orange headers), in the admin 1 level. Click on the “Geohelper” button, or hit the shortcut Ctrl + Shift + G. It opens a window, with several tabs, depending on whether you are in a “geo” (described by four visible columns) or in “hf” (decribed by one isible column).\nIf you are in a “geo” section, you will have three tabs that you can use to select administrative levels.\n\nCascade: select the admin levels with cascading menus, by selecting one admin level after the other, starting from the highest one.\nSearch: search by typing the name (needs at least 3 letters)\nHistory: quickly find a previous entry entered through the GeoHelper (does not work for data entered using the regular cascading dropdowns).\n\nOnce the location has been found, select it and click on “OK”.\n\n\n\nRefresh analyses\n\n\n\nRefresh analyses button\n\n\nHit the “Refresh analyses” button to update analyses on all analyses sheets in one go. You should use it whenever you entered new data or when you applied filters to existing data and want to see the analyses on this subset of data.4\n\n\nImports\n\n\n\nImports section\n\n\n\nImport data\nThe « Import Data » button allows you to import data in the linelist. This data must be in a special format typically produced by exporting data from another OutbreakTools linelist for the same disease.\nFirst a window opens to select the file to import. Select it and click on “OK”. At the end, a message will inform you of the success and provide a little import report is you wish so. Inspect it to see if there are any unexpected discrepancies (loosing variables should always be investigated!).\n\n\n\n\n\n\nImportant\n\n\n\nThe same button is used whether the data is partial (generated by the regular export button, anonymised or not, with metadata or not), or extensive (generated through the “Export for migration” button, from the Advanced section of the ribbon).\n\n\nIf there is already data in the file, a message will inform you of that fact and ask you what you wish to do. It is possible to append the new data at the bottom of the already present data. This is a handy way to create temporary master linelists, or to gather data entered by two data-encoders.\n\n\n\n\n\n\nWarning\n\n\n\nMake sure the data is not overlapping before importing, as the import will just paste the data at the bottom of the existing data, and you would end up with duplicates to clean.\n\n\n\n\nImport geobase\n“Import geobase” allows you to import a geobase in the linelist. If the current linelist had already a geobase, it will be replaced.\n\n\n\n\n\n\nWarning\n\n\n\nThe import of the geobase does not affect the data already entered in the linelist, it only fills the modalities offered by dropdown menus. If data is already present in the linelist and the new geobase has different levels, you need to correct them yourselves.\n\n\nGo here to learn how to download a geobase.\n\n\n\nExports\nThe regular exports buttons are available in the “Export section” of the ribbon, and the “Export for migration” is available in the Advanced section of the ribbon.\n\n\n\nExports section\n\n\n\nExport data\nOutbreakTools linelists have the feature to export data in a separated excel file, to share with partners or perform more advance analyses. The characteristics of the exports (which variables, anonymisation or not, password protected or not etc.) are pre-defined in the setup file that is used to generate the linelist.\nWhile Epicentre linelists should have at minima be an “Anonymous export for MSF” button, the other available exports differ between linelists created.\nTo export data, click on the “Export Data” button, which opens a popup window, with several options. At the top, you will see buttons for different exports. After clicking on the desired export, a window pops-up for saving the export. If “Export Filtered Data” is selected, a confirmation message will pop-up first to ask you whether this is what you really want.\nOnce the folder has been selected and after clicking “OK”, a new window opens to confirm the export and, if the export is protected, provide the associated password.\n\n\n\n\n\n\nTip\n\n\n\nIf you forgot the password, click on the “Export Button” again, and then click on the “Show actual private key” to display the password again.\n\n\nClick on the button “Generate new password” to change the password used by default.\n\n\nExport analyses\nYou can export all the tables from the analysis sheets in one document by using the “Export the analysis sheets” button and selecting the directory where you want to save them.\n\n\n\n\n\n\nWarning\n\n\n\nIf the analysis are made on filtered data, the tables will be exported as such.\n\n\n\n\n\nRegister and Case report form\nYou can print a register directly based on the linelist.\n\n\n\nRegister and case report form section\n\n\nThe features from this category only work if you are on a data entry sheet, otherwise you get an error message.\nClick on “Show register”; it opens a new sheet that contains all the variables from the linelist. On this sheet, you can use the Data Table features can be used just as in the original linelist sheet:\n\n“Add rows” and “Resize table” work exactly the same (except that it adds 10 rows at once)\n“Show/Hide variables” works the same but looks a bit different. Instead of “Show” you can select “print” and the orientation of the header. You can also import the parametrisation of hidden/shown columns from the regular linelist table, or change column width.\n\nYou can rotate all the labels at once by clicking the “Rotate headers” button. You can define the heigh of the row by clicking directly on “Row height”, a pop-up opens where you can define the heigh.\nAll labels are editable.\n\n\n\n\n\n\nTip\n\n\n\nYou should hide all calculted variable, they have no place i a register book\n\n\nOnce customized, you can close the sheet by clicking the red cross, all your modifications are saved.\nOnce ready, you can use the “Print” button to open the print preview view (whether you are on the register sheet or the linelist sheet). All the variables to be printed fit one page (landscape). If you are satisfied, you can print.\n\n\nAdvanced\n\n\n\nAdvanced button and pop-up window\n\n\n\nExport for migration\nThis button exports raw data and metadata for migration to another linelist file.5\nYou can choose to export the patient data, the geobase and the history of the geobase (history list in the GeoHelper), by ticking the matching cases. There are also options to include metadata on the state of hidden/shown columns (to not have to redo the full setup in the new file), and the updated labels of the custom variables, if you used these variables.\n\n\n\nExport for migration\n\n\nAfter selecting the options and clicking on “Export”, a window pops-up for saving the export. Select the folder and click on “OK”. Once finished a message appears to ask if you want to close the window.\nThe export creates three files:\n\na file containing the data and all sort of metadata\na file containing the geobase that is currently in the linelist, as well as the history from the GeoHelper\na file containing only the GeoHelper history (in case you want to upgrade to a new version of the geobase but wished to keep your GeoHelper history)\n\n\n\nImport geobase history\nThis button allows you to import a file containing the history of the geobase (such a file was created by exporting the data from migration, see above).\n\n\nLast Import Report\nThe button allows you to display the report from the last import made.\n\n\nDelete data or geobase history\nThis are a dangerous buttons that allows you to delete data or geobase history from the linelist.\n“Delete all data” allows you to remove all the data you entered from the workbook. After clicking, you will have a warning message. To confirm the deletion, you will need to enter the full name of the file.\n“Delete geobase history” allows you to empty the table with the geobase history so the list of suggestion of the history method from the GeoHelper will be empty.\n\n\nRestore the state of hidden columns\nThis button allows you to restore the state of hidden columns (i.e. hide them all again) if, for any reasons these columns had been shown.\nNote that hidden columns are not supposed to be shown, and the user can thus not modify their visibility state from the regular Show/Hide variables button, hence this button." }, { "objectID": "reference/ribbons.html#footnotes", diff --git a/sitemap.xml b/sitemap.xml index eb3d432..39f1828 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,94 +2,94 @@