Manage Reports
Abbreviations Key | |
HISE | Human Immune System Explorer |
At a Glance
A report is a key content asset in any publication. It's formatted as a Google Doc, Sheet, or Slide (or as a Microsoft Word doc or PowerPoint slide) and housed in a study space. Reports can be shared with anyone who has a Google account. You can edit or delete a report before publication. You can also choose a hero (thumbnail) image to represent the report in your study space. After publication, you can delete a report only by deleting the entire publication.
Instructions
To work with the reports in your study space, and log in with your organization's email account. From the top navigation menu, choose COLLABORATION SPACE, and follow the instructions in the applicable section below. For questions, contact .
Find a Report
Search by Tag
1. On the Your Studies page, click the study that contains the report you want to find.
2. Click the applicable tag at the top of the Studies > [Your Study] page. Only studies with the selected tag now appear on screen.
Search by Date
1. Near the upper-right corner of your screen, below Create Report, find the Sort by field.
2. Click the arrow and choose Latest Modified (most recently changed reports) or Oldest Modified (reports changed less recently) from the drop-down list. The last modified date and time appear at the bottom of each report tile.
Search Alphabetically
1. Near the upper-right corner of your screen, below Create Report, find the Sort by field.
2. To sort reports alphabetically by title, choose A–Z. To sort in reverse alphabetical order, choose Z-A.
Create a Report
1. On the Your Studies page, click the study that will house the new report.
2. In the upper-right corner of the Studies page, under Edit Study, click Create Report.
3. In the Create new report dialog box, fill out the metadata fields:
A. In the Report title field, give your report a descriptive title.
B. In the Authors field, enter the names of the principal investigators.
C. In the Summary or abstract field, paste your abstract or briefly describe the scientific question the study investigates and the conclusions it draws.
D. To upload an alternative to the default thumbnail image on your Report tile, use the Hero image field. For details, see the section of this document.
E. In the External contributors field, type the email address of each contributor you want to add, and press Enter.
F. To assign a role to a new contributor, click the triangle next to WRITER and choose a role from the drop-down list.
G. In the Document type field, choose a Google or Microsoft document type from the drop-down list.
H. The Notify new users when they are added to this report? field defaults to YES. If you prefer not to notify a given user, click NO.
4. Click Submit. Your new report appears as a tile on the Studies > [Your Study] page.
5. To add tags to your report, see the section of this document.
6. In the lower-right corner of your report tile, to the left of the pencil icon, click the document icon, and fill in the document template that appears.
Add Tags to a Report
Tagging your report makes it easier for other scientists to find, which increases the visibility and value of your work. Tags are not part of the report creation metadata and can be added to a report only after it's created. Tag values can include name, version number, group ID, data origin (such cohort name), status (such as deprecated), or any other unique identifiers that make your work easier to find and organize. Only numbers, lower-case letters, and underscore symbols are accepted. Capital letters, hyphens, and other unacceptable characters will be removed. |
1. Create a report. For details, see the Create a report section of this document.
2. On the Studies > [Your Study] page, find the report you want to tag. For search instructions, see the section of this document.
3. In the lower-right corner of your report tile, click the pencil icon.
4. In the Edit report settings dialog box, in the Tags field, click Add All to add all tags available to the study space that houses your report. Then click the X to remove any unwanted tags individually. (If no existing tags appear when you click Add All, proceed to the next step.)
5. Alternatively or in addition to the existing tags, in the Tags field, type in one or more new tags to identify your report.
6. To save your tag selections, click Submit.
Add or Remove a Contributor from a Report
You can list your collaborators when you create a report, or you can add them to an existing report at any time before your study is published.
Share a new report
1. On the Your Studies page, choose the study space where you want to create the new report.
2. In the upper-right corner of the Studies page, under Edit Study, click Create Report.
3. In the Create new report dialog box, enter the report title, authors, and other metadata. Then, in the External contributors field, type the email address of the contributor you want to add, and press Enter.
4. To assign a role to the new contributor, click the triangle next to WRITER and choose a role from the drop-down list. For details, see the accompanying box.
Role | Description |
WRITER | User with full access to edit or delete a report. All study owners have writer access and can grant the same permissions to other users as needed. For transparency, however, such permission changes should be made only at the study level. Navigate to Collaboration Space > Your Studies > Settings (gear icon) > Share with users. |
READER | User with read-only access to a report. |
COMMENTER | User with permission to read and comment on a report. |
5. In the lower-left corner of the dialog box, find Notify new users when they are added to this report? The answer field defaults to YES. If you prefer not to notify the user, click NO.
6. Click Submit.
Add or remove a contributor from an existing report
1. On the Your Studies page, find the study space that contains the report you want to share or change.
2. In the lower-right corner of the tile, click the pencil icon to edit the report settings.
3. In the Edit report settings dialog box, find the External contributors field:
A. To remove a contributor
1. Find the person's name below the text field.
2. Click the triangle next to WRITER, and choose REMOVE USER from the drop-down list.
3. Click Submit.
B. To add a contributor
1. In the text field, type the email address of the contributor you want to add.
2. Click ADD USER.
3. Click Submit. Then assign an appropriate role to the new contributor (for details, see ).
Change the Hero Image
When you create a study, a random abstract thumbnail image appears in the hero image space on the report tile. You can upload a different image from the study Drive or from a saved visualization.
Upload a hero image from Drive
1. On the Your Studies page, find the study space that contains the report you want to share or change.
2. In the lower-right corner of the tile, click the pencil icon to edit the report settings.
3. In the Edit report settings dialog box, in the Hero image field, click Drive.
4. In the Study Drive dialog box, choose the Upload tab. Then drag and drop the image file, or click Select files from your device. Then browse your file tree for the image you want to use, and double-click to select it.
5. Alternatively, in the Study Drive dialog box, choose the Google Drive tab. Then find the file you want to use:
A. In the search field next to the magnifying glass icon, type a keyword from the filename you want to find, such as heatmap
, or type the extension of an image file, such as .png
.
B. To toggle from list view to grid view, click the layout icon in the upper-right corner.
C. To filter the results by last modified date or by name, or to show only the files last modified or opened by you, click the A–Z icon in the upper-right corner.
6. Choose an image and then, in the lower-left corner of your screen, click Select.
6. Click Upload.
Upload a hero image from a saved visualization
1. On the Your Studies page, find the study space that contains the report you want to share or change.
2. In the lower-right corner of the tile, click the pencil icon to edit the report settings.
3. In the Edit report settings dialog box, in the Hero image field, click Visualizations.
4. To find, sort, and filter your visualizations, follow the instructions given in the previous section (Upload a hero image from Drive).
5. Select an image, and then click Submit.
Copy a Report to a Different Study
1. On the Your Studies page, choose the study space that contains the report you want to copy.
2. On the Reports page, in the upper-right corner, click Copy report.
3. In the Copy report dialog box, click the arrow next to the Move report to a different study field.
4. From the drop-down list, choose the study in which you want the copied report to appear.
5. Click Submit.