First time users
Tips to first time users!
4 minute read
OpenDataBio is software to be used online. Local installations are for testing or development, although it could be used for a single-user production localhost environment.
AttentionIf you have registered you need someone to assign you a full user role, so you can enter data.
- If you are installing, the first login to an OpenDataBio installation must be done with the default super-admin user:
password1. These settings should be changed or the installation will be open to anyone reading the docs;
- Self-registrations only grant access to datasets with privacy set to
registered usersand allows user do download data of open-access, but do not allow the user to edit nor add data;
- Only full users can contribute with data.
- But only super admin can grant
full-user roleto registered users - different OpenDataBio installations may have different policies as to how you may gain full-user access. Here is not the place to find that info.
See also User Model.
Prep your full-user account
- Register yourself as Person and assign it as your user default person, creating a link between your user and yourself as collector.
- You need at least a dataset to enter your own data
- When becoming a full-user, a restricted-access Dataset and Project will be automatically created for you (your Workspaces). You may modify these entities to fit your personal needs.
- You may create as many Projects and Datasets as needed. So, understand how they work and which data they control access to.
There three main ways to import data into OpenDataBio:
- One by one through the web Interface
- Using the OpenDataBio POST API services:
- importing from a spreadsheet file (CSV, XLXS or ODS) using the web Interface
- using the OpenDataBio R package client
- When using the OpenDataBio API services you must prep your data or file to import according to the field options of the POST verb for the specific ‘endpoint’ your are trying to import.
R TutorialsSee the Import data with R Tutorial for examples on how to import data with API.
Tips for entering data
- If first time entering data, you should use the web interface and create at least one record for each model needed to fit your needs. Then play with the privacy settings of your Workspace Dataset, and check whether you can access the data when logged in and when not logged in.
- Use Dataset for a self-contained set of data that should be distributed as a group. Datasets are dynamic publications, have author, data, and title.
- Although ODB attempt to minimize redundancy, giving users flexibility comes with a cost, and some definitions, like that of Traits or Persons may receive duplicated entries. So, care must be taken when creating such records. Administrators may create a ‘code of conduct’ for the users of an ODB installation to minimize such redundancy.
- Follow an order for importation of new data, starting from the libraries of common use. For example, you should first register Locations, Taxons, Persons, Traits and any other common library before importing Individuals or Measurements
- There is no need to import POINT locations before importing Individuals because ODB creates the location for you when you inform latitude and longitude, and will detect for you to which parent location your individual belongs to. However, if you want to validate your points (understand where such point location will placed), you may use the Location API with
querytypeparameter specified for this.
- There are different ways to create PLOT and TRANSECT locations - see here Locations if that is your case
- Creating Taxons require only the specification of a
name- ODB will search nomenclature services for you, find the name, metadata and parents and import all of the them if needed. If you are importing published names, just inform this single attribute. Else, if the name is unpublished, you need to inform additional fields. So, separate the batch importation of published and unpublished names into two sets.
notesfield of any model is for both plain text or JSON object string formatted data. The Json option allows you to store custom structured data any model having the
notes field. You may, for example, store as notes some secondary fields from original sources when importing data, but may store any additional data that is not provided by the ODB database structure. Such data will not be validate by ODB and standardization of both tags and values depends on you. Json notes will be imported and exported as a JSON string, and will be presented in the interface as a formatted table; URLs in your Json will be presented as links.
Last modified January 11, 2022 : Add PUT API info and how to customize layout (12ea724)