Hello and welcome to Datazar! We're glad to have you here. This guide will help you get started with Datazar and show you everything you need to get up and running with your first project.
The first thing you should do when you join Datazar is complete your profile. When you first sign up, you'll get a chance to do that as the on-boarding process will ask you to input a few things about yourself. If you skipped that part, don't worry we all do it, you can always naviagte to your settings and update your information.
The reason it's important to have a full profile is that when you publish your data and/or research, people who consume it have higher confidence in it and you if they know you're a real person.
So having a full profile always boosts people's confidence in your work.
Projects are where all your data, scripts and any other material go when you're working on a particular research project. Let's use an example project. We'll call it 'Project Sigma'. Everything that has anything to do with that research project will go under 'Proect Sigma'.
When you first register, you'll have a default project called 'Getting Started.' This project has a few examples including datasets, r scripts, charts and LaTeX documents. It's your sandbox when you want to experiment as a new user.
Back to 'Project Sigma.' To create a new project, click on the 'New Project' button located in top right corner of any page. This button is available on any page once you're logged in. Clicking on it will prompt a popup with a few fields.
Enter 'Project Sigma' in the field 'project name' and then enter a project description (it's optional). Lastly, choose if you want to make your project Private or Public. To create a Private project, you must have a Student, Pro or Team account. You're all done, click on the button 'Create Project' and you'll be taken to your newly minted project.
Uploading files is a breeze. First navigate to any of your projects. If you're following from the above section, navigate to the projet we just created-'Project Sigma.' You'll be greeted by the Overview section. In the Overview section, there is a grid of file types you can choose from to create. There is also a button with a plus sign on it and the text 'Upload File.'
Once you click on it, you'll see a popup. Click on the 'Choose File' button to select a file from your computer. Fill out description field if you want to describe what the file is about (always recommended if you want people/collaborators to understand easily).
Once you have selected the file, you can optionally change its name on upload by editing the 'name' field next to the 'Choose File' button. If you're done, click on the 'Upload' button. And that's it! The 'Upload' button will appear grayed out and disabled if you haven't selected a file from your computer. Once a file is selected the button will glow green letting you know you're all set for upload.
In Datazar, you can upload files and you can also create files directly from your browser. The list of supported files that can be created is always growing so be sure to check the product page for updates.
For this example, let's create an R Notebook. An R Notebook let's you run R commands and get results in realtime all in your browser.
Navigate to any of your projects and you'll land on the Overview section. The overview section contains a grid of file types you can choose from to create.
For this example let's click on the blue 'R Document' button. This will prompt a popup asking us what type of R Document we want to create. We can choose between 'R Console', 'R Notebook' and 'R Script' but for this guide we'll go with R Notebook.
As soon as we click on 'R Notebook', we'll be redirected to the notebook interface to start typing R notebooks!
Datazar has a full REST API where you can stream data and send data directly. If you have devices that you want to send data or have applications that consume some data, you can connect them to the Datazar API and have them send data to and from datasets in your projects.
The API inherits the permissions you set from your projects. Private datasets won't be accessible by users who do not have access to them through the Datazar web interface. To view the full documentation of the REST API, head over to docs.datazar.com.
To access the REST API, you'll need an API token. API tokens let you access the API and serve as your password to the API so that you don't have to use your account password. Tokens can be revoked at anytime by the owner (the account that created them). There is no limit to how many tokens you can create.
To create a token, head to the settings page of your account. Tokens are project and file agnostic so you create them from your account settings and not from the project settings. The settings can be found by click on your profile picture in the top right corner of any page. The profile picture will display a dropdown. Click on 'Settings.' Once on the 'Settings' page, navigate to the 'Tokens' section. All you have to do now is click on the 'Create New Token' button. This will display a popup where you have to name the token for reference purposes.
Once you're done naming the token, click on the 'Create Token' button. And you're done! When you have clicked the 'Create Token' button, you'll be asked to save the token. For security reasons, this will the only time the token will be displayed so go ahead and click on the 'copy' button. This will copy the newly created token to your clipboard so you can paste is somewhere safe.
One way to make the most out of your experience with Datazar is to follow different people and collaborate on projects you find interesting. Did you know you can contribute data and help with analyzing datasets on any public projects?
To find people and projects, head over to the Explore Page and filter using keywords that interest you. In the same note, having tags in your profile ensures people with similar interests follow you and contribute to your open projects.
And that's it! We hope this has helped in getting started with Datazar! Don't forget, you can find more guides on docs.datazar.com/guides. If you have any questions, don't hesistate to contact us on firstname.lastname@example.org.