Como Criar um Projeto no ToGatherUp:
Um Guia Passo a Passo para Pesquisadores
Siga os tutoriais desta seção e torne-se proficiente no uso do ToGatherUp em seus projetos.
Introduction
Welcome to ToGatherUp tutorials. In this tutorial series we will guide you through the process of creating a project in ToGatherUp. By the end of tutorials, you will have a clear understanding of how to create and manage your own projects in ToGatherUp.
Por Fernando Oliveira
em 14 de Abril de 2023
Tutorial 1: Creating an Account
Before creating a project in ToGatherUp, you need to create an account. To create an account, go to the ToGatherUp website (https://www.ileel.ufu.br/togatherup/) and click on the "Create Account" button at the top right corner of the page. Fill in your information and click on the "Submit" button.
After completing the registration process, an email will be sent to the email address you provided with a link to activate your account. Please check your email inbox (and spam folder, just in case) for this message and click on the activation link to complete the account creation process. Once your account is activated, you will be able to log in to ToGatherUp and start building your research dataset.
If you already have an account, you can skip this step and click the “Sign in” button in order to access ToGatherUp.
By Fernando Oliveira
on Apr 14 2023
Tutorial 2: Creating a Project
Once you have logged in, you can create a new project by clicking on the "New Project" button on the dashboard. Fill in the project details and click on the "Continue" button. Your project will be created. You will see the Project Overview screen.
Project Overview is a comprehensive interface within ToGatherUp that provides a centralized view of all aspects of your project. This interface allows you to easily access and manage various data-related project interfaces, including Data Entry, Data Manager, Data Structure, Data Exportation, Data Import, and their respective settings.
In addition, the Project Overview interface also enables you to manage your team and view the active metadata and file name conventions of your project. Another feature of Project Overview interface is the visualization of metrics of your project metadata which allows for streamlined management and optimization of the research process.
In the next tutorials, we will dive into each interface available in Project Overview. By following these tutorials, you will learn how to manage and work on your project effectively.
By Fernando Oliveira
on Apr 14 2023
Tutorial 3: How to add members to your project
ToGatherUp allows you to add collaborators to your project. Collaborators can be other researchers, students, or anyone else who you want to work with on the project. To add collaborators, in Project Overview, access the “Team” interface. Then, click on the "Add Member" button and enter the email address of the member you want to add.
Before adding a member to your project, ask him to create an account on ToGatherUp. Only registered users can be added to the project team.
You can also set the member role for the project. Members with a "Member" role will be able to add data resources to the project but will not be able to change project configurations. To allow a member to change project configurations, set their role as "Manager".
After entering the email and role of the new project member, click on the "Go to Project Overview" button located at the top right of the page to return to the Project Overview.
By Fernando Oliveira
on Apr 14 2023
Tutorial 4: Setting Up Your Project
ToGatherUp allows you to configure various aspects of your project to better suit your needs. To do this, you will need to access four different setting interfaces: General Settings, Metadata Settings, Data Structure Settings, and File Name Convention Settings. You can access these interfaces by clicking on “Settings” in Project Overview.
The first interface we will see is the “General Settings”. Click “Go to General Settings” to access it. In the General Settings, you will be able to edit the basic information of your project. You can change your project name, description, purpose and language. You can also change the status of the project and set a deadline for its completion.
In the General Settings interface, you can delete your project if needed. However, please note that this action is permanent and will delete all the project associated data resources and configurations. Once a project is deleted, it cannot be recovered.
After reviewing your project settings, click on the "Go to Project Settings" button located at the top right of the page to return to the Project Settings.
By Fernando Oliveira
on Apr 14 2023
Tutorial 5: Setting Up Your Project Metadata
The second interface we will see is the “Metadata Settings”. Click “Go to Metadata Settings” to access it. In the “Metadata Settings”, you will be able to select the metadata attributes that may be recorded for every data resource introduced into your project.
Metadata refers to data that provides information about the data resources in your project. ToGatherUp offers a wide range of metadata attributes that can be selected to fit different types of research.
To select the relevant metadata for your project, simply check the boxes next to the metadata name and click the "Save Selection" button in order to make them available for your project. Note that you can select multiple metadata at the same time before click the "Save Selection" button.
Metadata Settings interface presents a search option to help you and some metadata present and “About” text explaining what the metadata is.
The selected metadata will then be displayed in the Data Entry interface when you add new data resources to your project.
Some metadata have predefined options that could be selected by clicking the “Define options” button. In “Metadata Options Settings” you could check the boxes next to the metadata options names and click the "Save Selection" in order to make them available for your project.
Now, let’s return to Project Settings by clicking on the "Go to Metadata Settings" and "Go to Project Settings" button located at the top right of the page to return to the Project Settings.
By Fernando Oliveira
on Apr 14 2023
Tutorial 6: Setting Up Your Project Data Structure
The third interface we will see is the “Data Structure Settings”. Click “Go to Data Structure Settings” to access it. In the “Data Structure Settings”, you will be able to configure the “Project Data Structure” of your project.
A "Project Data Structure" is the hierarchical categorization system used in ToGatherUp to efficiently manage and organize data in a project. It is agnostic to the theoretical framework or approach adopted by researchers and can be adapted to different theories or data categorization schemes. ToGatherUp provides the metadata "Data Structure Position" that could be applied to data resources in order to categorize them.
The "Project Data Structure" resembles a tree-like structure with the topmost level named as "Root folder” and each subsequent levels named as “Branch folders”. Each branch folder could contain additional branch folders. This allows for a logical and easy-to-navigate organization of files and folders when you export your project.
To begin your “Project Data Structure" configuration, go to panel "Setup Root Folder" and establish the “Root Folder” of the project. Then, Go to panel "Create Branch Folder" and create remaining branch folders of the project, organizing them by branching them out from its parent folders.
On panel "Project Data Structure", you will see your "Project Data Structure" and could right-click on the folder to edit its name or delete it. You can also click with the left mouse button on a folder and drag it to another position.
You could import an existing “Data Structure” into the project and we will explain how to do this in the next tutorial. If you intend to do that, we recommend that you go directly to the Data Import section and proceed with the importation from there instead of setting "Project Data Structure" in “Data Structure Settings”. We recommend this because any pre-existing Data Structure will be replaced by the imported Data Structure.
After setting up your "Project Data Structure", click on the "Go to Project Settings" button located at the top right of the page to return to the Project Settings.
By Fernando Oliveira
on Apr 14 2023
Tutorial 7: Importing and existing Data Structure and files to your project
If you want to import an existing “Data Structure” into your project, click on the “Data Import” option available in “Project Overview”. Data Import is a ToGatherUp interface that allows you to import external data into your project.
The first step is compressing data to be imported into a .zip file. Next, go to “Choose a zip file to upload:” and add the .zip file. Only .zip format with a maximum size of 340 Mb can be uploaded. After adding the file, click the Upload button to continue.
ToGatherUp will try to identify the Data Structure inside the uploaded file and will ask you to review it before proceeding with importation.
In the “Data Structure and Files” panel you could review the Data Structure and Files recognized by ToGatherUp inside the uploaded file. If they match your expectations, click the “Execute Import” button to confirm the importation execution.
ToGatherUp will then register the new Data Structure as the “Project Data Structure” and add files to your project, attempting to attribute to them the metadata “Data Structure Position” that reflect their respective positions in the imported Data Structure.
Please note that any previously created Data Structure will be replaced by the new Data Structure, if it exists.
By Fernando Oliveira
on Apr 14 2023
Tutorial 8: Setting Up Your Project File Name Convention
The next interface we will see is the “File Name Convention Settings”. Click “Go to File Name Convention Settings” to access it. In the “File Name Convention Settings”, you will be able to establish rules for naming the files of your project when they are exported from ToGatherUp.
File Name Convention refers to a set of rules that dictate the structure and composition of the name given to a file. This convention typically includes various informative segments, such as the creation date, identification code, author name, content area, version, and others, which are combined to provide enough information to identify the file content from its name.
The main purpose of the File Name Convention is to establish a consistent and organized way of naming files to facilitate their identification, location, and management, particularly in large and complex projects.
A well-designed File Name Convention can also help to create subsets of files or subcorpora based on the metadata present in their names.
Before setting up the File Name Conventions of your project, let’s understand how does File Name Conventions are used in ToGatherUp.
In ToGatherUp, project files are automatically named according to a convention established by the project leader or manager. The file name is composed of segments that represent the metadata defined in the convention. Each segment has three characters, with some exceptions*, that abbreviate the metadata associated with the file. The segments are separated by hyphens and the file name always ends with the .txt extension.
To illustrate, imagine that a researcher submitted a file to the "Data Entry" section of ToGatherUp and assigned the metadata "Position in Data Structure," "Target Audience," "Language," and "Publication Date" to it.
- For the "Position in Data Structure" metadata, the researcher selected the option "Artificial Intelligence".
- For the "Target Audience" metadata, he selected the option "Researchers".
- For the "Language" metadata, he selected the option "English".
- For the "Publication Date" metadata, he indicated March 29, 2023.
In the project settings, the researcher established a "File Naming Convention" including these same metadata in this order:
- 1 - Position in Data Structure
- 2 - Target Audience
- 3 - Language
- 4 - Publication Date
Based on these metadata and the convention, ToGatherUp named the file as follows: ART-RSH-ENG-29Mar23-34.txt
As we can see, ToGatherUp used the first three characters of "Artificial Intelligence" to create the abbreviation ART. For the "Target Audience" and "Language" metadata, it abbreviated "Researchers" as RSH and "English" as ENG. These abbreviations were pre-established in the internal settings of the tool. The "Publication Date" was included in the standardized format "29Mar23". Next, the number 34 was generated and automatically included by ToGatherUp. This number corresponds to the Internal Identifier (ID) of the file within the ToGatherUp database structure. The ID is mandatory for all files and plays the important role of ensuring that there are no files with similar names in the project. If the ID were not included in the file names, there would be a risk of files having identical names if their metadata were identical. Finally, ToGatherUp included the .txt extension in the file name.
Now that you learned how ToGatherUp deals with File Name Conventions, follow these steps to setting up the File Name Convention of your project.
In the “File Name Convention Settings” interface, go to "Available Metadata for FNC", click on the handle of the metadata box and drag it to panel "FNC elements". By doing it, you are including dragged metadata in the FNC of your project.
To remove metadata from your project FNC, do the reverse.
You can also use the handles of the metadata boxes to change the order in which they should appear in the filenames.
The names of the files in your project will be composed of the metadata added to the "FNC elements" panel and the original file extension.
Once you have set up the File Name Convention for your project, you are ready to start working. To do so, simply click on the "Go to Project Overview" button located at the top right of the page. This will take you to your Project Overview where you can begin adding your data resources.
Exceptions:
Metadata related to dates and numbers are not abbreviated.
By Fernando Oliveira
on Apr 14 2023
Tutorial 9: Adding data resources to your project
Now that you have configured the necessary settings for your project, it is time to learn how to include data resources into it.
The Data Entry is a ToGatherUp interface aimed to input data resources into the project. The interface helps ensure that the data resource entered is consistent and standardized, making it easier to be managed and retrieved later.
Data Entry presents input fields for each metadata selected in Project Metadata Settings. To include a data resource in your project, go to the “File” panel and add the file of the data resource to be included. Next, go to the “File Metadata” panel and fill out the metadata input fields.
Finally, click on the "Save New Data" button to save the data resource and its metadata.
The saved data resource will be displayed in the Data Manager interface, available in Project Overview.
By Fernando Oliveira
on Apr 14 2023
Tutorial 10: Managing project data resources
Data Manager is the ToGatherUp interface that allows you to view a list of data resources of your project in an organized and simple manner. To access it, go to “Project Overview” and click on the option Data Manager available on it.
Through this interface, you can search for specific data resources using their metadata. With the Data Manager, you have access to all your texts in a centralized manner and can work with them more efficiently.
You can use the “Actions” menu to edit, delete and view your project data resources. Edition will allow you edit only data resource metadata. If you want to edit the data resource, go to “Actions > View” and ToGatherUp will show the content of the data resource inside a text editor. After you do the edition, remember to click the “Save” button in order to save it.
By Fernando Oliveira
on Apr 14 2023
Tutorial 11: Exporting project data
The Data Exportation interface in ToGatherUp allows you to export your project data in a convenient and customized way. To access it, go to “Project Overview” and click on the option Data Exportation available on it.
At the “Export Configuration” panel, you can set if ToGatherUp should include headers with data resource metadata at the top of exported files of your data resources. To do this, activate “Include headers in files” control.
In the “Export Configuration” panel, you can also set if ToGatherUp should try to convert character encoding of files that will be exported. By default, the exporting character encoding is set to UTF-8.
UTF-8 is the most widely used character encoding on the web today, and it is generally a good choice for new projects because it supports a wide range of characters and is compatible with ASCII. However, the specific encoding you should use depends on your specific needs and requirements.
Once the exportation settings are configured, you can select the data you want to export. You could export all project files, all files for a specific metadata or all files for a specific metadata option. Next, we explain how to do each one of these exportations.
- Export all project data resources: In order to export your entire dataset click the “Export all project files” button.
- Export all data resources of a metadata: In order to export a dataset composed only for data resources of a specific metadata, click the “Export files” button available at the desired metadata panel.
- Export all data resources of a metadata option: In order to export a dataset composed only for data resources of a specific metadata option, click the “Export files” link in front of the desired metadata option on its parent metadata panel.
In every case of exportation, ToGatherUp will get desired data resources, compress them inside a .zip file and download it for you.
By Fernando Oliveira
on Apr 14 2023
2022©
ToGatherUp
