My tutorial needs to be reviewed

[ruobinLiu]

Hey teams! Can you please review my "how to upload raw phenotypic data" tutorial when you have a chance? Thank you in advance :)

[carolyncaron]

Here are my suggestions!

Main page

• For title, I suggest "How to store raw phenotypic data in KnowPulse"
• For Purpose, add an appostrophe + s to KnowPulse ("This lesson will show you how to use KnowPulse's raw phenotype importer...")

Setup tab

• "Creat an account" is missing an e
• The screenshot at the bottom of the page appears to be missing

Project setup

• I would change "Once you have your data file ready to be uploaded," to "Before you start collecting phenotypic data in the field," since it would ideal to set up a project before they even start collecting! And then they will hopefully be backing up the data as its collected.
• I'm a little confused by the details that are needed to set up the project. I would try to make this section more clear and provide examples. For example, what "Name" do you mean? ;) I would say something like "Trait name (eg. Days till 10% of Plants have Elongated Tendrils)"
• Instead of "The trait description step can also be finished during data uploading." I would say "Alternatively, the trait definition can be described at data upload."
• For the last paragraph, I would say something like "Once someone has helped create a project for you, the raw phenotype importer will generate a customized spreadsheet template for your data collection."

Fill your data in the data collection spreadsheet

• A simpler title for this section could be "The data collection spreadsheet"
• When you provide links in a tutorial that requires being logged in to access, I like to add in brackets: (needs login to access).
• "A to E are default columns, follow by your traits." could be changed to "A to E are default columns, followed by one column per trait." In this paragraph I would also briefly describe the difference between green and grey coloured columns. Actually, is this information needed from the phenotyper in the previous step? It should be brought up then as well!
• Instead of "if you intend to upload multiple files" perhaps "If you think you will need to upload multiple files"
• Under Key Points, change to "Make sure all the names under the name column match existing germplasm in KnowPulse." and perhaps also provide a link to the germplasm search so they know where to check!

Backup and upload your data

• The Objectives appears to be incomplete
• The link for "Data backup function" should also mention that it needs account access
• I would emphasize that the file needs to be XLSX format here!
• "A text file for file comments, description and notes is provided for future reference." I think you're referring to the text box here. So I would word it as "A text box for describing data collection in its current state is provided to make it easier to reference back to if needed."
• I think the "My Raw Phenotypes" panel only shows up on the KP homepage, not all pages. I would mention that the panel can be found at the top of the homepage.
• Under "2. Describe New Trait" I would say "At this stage, your spreadsheet is examined for additional traits. Traits should have been described during project setup and you will see the descriptions in a greyed-out text box. If they haven't yet been described, please do this now (see Project Setup for details)". @reynoldtan can you double-check that they do appear greyed out and non-changeable?
• Under "Key Points", I would change "even it is not clean." to "regularly. The data is expected to be raw, so don't worry about cleaning it up between backups or for upload."

View and download your data

• The first sentence should say something like "like in the example below." before the link it provided (also needs access, I think!)
• Congratulation is missing an "s" at the end
• Instead of "Helps and more" I would title this "Final Thoughts"
• Under Key Points, change to "Log into KnowPulse with your user account before viewing and to download your data."

Great work, please poke me if you need any clarification on anything I suggested!

[reynoldtan]

Project setup

1. Once you have your data file ready to be uploaded, please get in touch with us via
   I think we want to do all the setup prior to any phenotypic data collection work...
   suggestion: To begin data collection in your trial, please contact [email protected] to setup your project in Knowpulse.

Then emphasize what user will be getting or benefits if they have a properly setup project in KP namely

• Access to information (text and photo) on how data should be collected for each trait
• A page to download data collection spreadsheet file pre-filled with project specific traits and formatted in way expected by Knowpulse/module. This file is used to record data.
• A space in Knowpulse that they can backup spreadsheet file and access backed up files anywhere.

2. Apart from trait description that will be asked, we also need information about the project and from the Add project page of Tripal it needs

• Project Name
• Project Description

3. Let's not suggest at this point that they can describe the traits later during the upload. We can add this message when describing the upload stage in another page. The real purpose of the describe trait during upload is for 1 or 2 maybe 3 traits that have been detected in the spreadsheet that is/aren't defined in the project and not the entire trait set of the project.

Here's the project page

Download Data Collection Spreadsheet

1. Here's a step by step guide to downloading a spreadsheet file.

How to download data collection spreadsheet file?

1. Click Change Project link, located next the project title of the currently active project to show Change Project Form.

2. Select a project when prompted. The instructions page will reload with a new active project. This will ensure that you are downloading the data collection spreadsheet file corresponding to a project that you are working on.

3. Click the Download Data Collection Spreadsheet link in the Standard Procedure Tab to begin file download. Click save when prompted.

4. To focus on the columns... If possible, can you take another screenshot of your sample spreadsheet file but hide the controls of ms excel? Try clicking the up arrow head (^) at the extreme right hand end of that control panel to hide.

5. see @carolyncaron comments on the paragraphs following this screen capture.

Data Backup

1. Overview/objective suggestion
   Backup page allows active users appointed to a project to backup multiple versions of their data collection spreadsheet file into the server before submitting them to the module through the Upload Data Page.

Page anatomy

How to manage your backed up file

How to back up a data collection spreadsheet file?

1. Select the project that corresponds to data collection spreadsheet file.
2. Drag and Drop file to the File Drop Zone Area or click choose file to launch file browser window.

3. Type notes, comments or description.
4. Click Upload Button.

How to download a file?

1. In File Browser, click the name of the file link under the File column or the download icon (arrow pointing down) to start file download.
2. Click save file when prompted

How to archive, restore and delete a file?

1. In File Browser, click the Trash Bin icon to archive a file. Trash icon will indicate that there are archive files in a project.

2. Click Archive file indicator to disclose archive files table.

3. In archive files table, options to restore file and physically delete file will become available. You will be prompted to confirm any action to a file.

4. Can the data upload be in a separate page? This page is huge.. I have full details of each stages and instructions as well as troubleshooting upload. Let me know if when you're setting up this separate page and I will send the info to you.

View data and download data and Helps and more

1. Let's move the part where they can get help in the fist page - setting up projects page. In the help page lets include email, KP homepage, link to SOP page, Link to backup, Link to Demo page
2. I have more info about view data and download. Please let me know when you're doing these pages.