-
Notifications
You must be signed in to change notification settings - Fork 32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feature add annotate excel guide #526
Changes from 3 commits
e8abee8
2a23463
7505458
4c1fc4f
8db155c
d4a2000
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
name: Patrick Blume | ||
socials: | ||
- icon: simple-icons:github | ||
href: https://github.com/Etschbeijer |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,11 +2,66 @@ | |
title: Annotate in Excel | ||
authors: | ||
- kevin-frey | ||
- patrick-blume | ||
sidebar: | ||
order: 1 | ||
badge: | ||
text: beta | ||
text: new | ||
variant: caution | ||
draft: true | ||
--- | ||
|
||
Lorem ipsum | ||
import { Steps } from '@astrojs/starlight/components'; | ||
import { Tabs, TabItem } from '@astrojs/starlight/components'; | ||
|
||
With the help of an [Excel-Add-In](https://learn.microsoft.com/de-de/office/dev/add-ins/excel/excel-add-ins-overview) you can manage your data, utilizing the [ARC](https://nfdi4plants.github.io/nfdi4plants.knowledgebase/core-concepts/arc/) standard, directly in excel, without the necessity to upload it anywhere. | ||
The functionality the excel-add-in provides are similar to [Swate](https://nfdi4plants.github.io/nfdi4plants.knowledgebase/swate/) and the differences will be explained in the different sections of swate. | ||
The excel-add-in will soon be published in the official [Microsoft Excel-Add-Ins Store](https://appsource.microsoft.com/en-us/marketplace/apps?product=excel). | ||
Currently, we recommend the installation using the [excel-browser version provided by microsoft](https://excel.cloud.microsoft/?wdOrigin=MARKETING.FREE.GO-TO-EXCEL) because the set up is much easier than with a local excel version. | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add "installation" header here and remove headers in tabs. Indent images to the right so they can be included in steps and do not restart the steps component after each image. Use one steps component and indent the content to fit it into the steps component There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. fixed |
||
<Steps> | ||
|
||
1. In order to annotate your data in Excel, based on the DataPlant standard, you have to download the [Manifest File](https://github.com/nfdi4plants/Swate/tree/main/src/Client/public). | ||
|
||
</Steps> | ||
|
||
<Tabs syncKey="swateHost"> | ||
<TabItem label="Browser"> | ||
|
||
<Steps> | ||
|
||
2. After downloading the manifest file, you have to upload it to Excel, by clicking on the Add-Ins button (a) in the start tab of Excel. | ||
3. Then you click on the Additional Add-Ins button in the exanded widget | ||
|
||
</Steps> | ||
|
||
![Swate Excel Brwoser Installation Step 1](@images/swate/swate-browser-excel-add-in-basic.png) | ||
|
||
<Steps> | ||
|
||
4. In the next step you select My Add-Ins (a) and Upload My Add-In. | ||
|
||
</Steps> | ||
|
||
![Swate Excel Brwoser Installation Step 2](@images/swate/swate-browser-excel-add-in-additional-ones.png) | ||
|
||
5. Then you select choose the folder where you have downloaded the [Manifest File](https://github.com/nfdi4plants/Swate/tree/main/src/Client/public) to and select it, in order to upload it. | ||
6. When the installation was successful, the icon of [Swate](https://nfdi4plants.github.io/nfdi4plants.knowledgebase/swate/), the Excel-Add-In for annotating data, should be available in the data tab. | ||
7. When you click on the icon the sidebar of swate should appear. Its size is adaptable and when it is big enough, the quick icons of the navbar are visible. | ||
8. When everything was successful, it should look similar to this: | ||
</TabItem> | ||
<TabItem label="Excel"> | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Did not remove headers in tabs There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These will be visible in the sidebar, even when they are hidden by selecting a different tab |
||
## Local installation | ||
Freymaurer marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
<Steps> | ||
|
||
2. Follow the installation guide for [Excel-Add-Ins](https://support.microsoft.com/en-us/office/add-or-remove-add-ins-in-excel-0af570c4-5cf3-4fa9-9b88-403625a0b460). | ||
3. When the installation was successful, the icon of [Swate](https://nfdi4plants.github.io/nfdi4plants.knowledgebase/swate/), the Excel-Add-In for annotating data, should be available in the data tab. | ||
4. When you click on the icon the sidebar of swate should appear. Its size is adaptable and when it is big enough, the quick icons of the navbar are visible. | ||
5. When everything was successful, it should look similar to this: | ||
|
||
</Steps> | ||
|
||
</TabItem> | ||
</Tabs> | ||
![Swate Sidebar Overview](@images/swate/swate-excel-overview.png) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,44 @@ | ||
--- | ||
title: Annotation Table | ||
lastUpdated: 2024-04-25 | ||
lastUpdated: 2024-11-14 | ||
authors: | ||
- kevin-frey | ||
- stella-eggels | ||
- patrick-blume | ||
--- | ||
|
||
import { Tabs, TabItem } from '@astrojs/starlight/components'; | ||
|
||
:::tip | ||
Consider reading about [Swate](/nfdi4plants.knowledgebase/swate) | ||
::: | ||
|
||
## Open or create an assay or study file | ||
<Tabs syncKey="swateHost"> | ||
<TabItem label="Browser"> | ||
|
||
## Add an annotation table | ||
|
||
To create an annotation table file with the [Swate standalone](https://swate-alpha.nfdi4plants.org/) in your browser, click "New File" and select which kind of file (investigation, study, assay) you want to create. If you already created a `isa.study.xlsx` or `isa.assay.xlsx` file, you can select "Import File" to modify and add to it. | ||
In the "New Table" sheet, you can create your annotation table by adding [building blocks](/nfdi4plants.knowledgebase/swate/building-blocks). | ||
Your annotation table should consist of an "Input", multiple descriptive building blocks ("Characteristics", "Parameters", "Components") and an "Output". | ||
|
||
![Image showing add new file option in Swate](@images/swate/swate-alpha-new-file.png) | ||
To create an annotation table within ARCitect, add a new table to your assay or study by clicking the plus (+) symbol next to your metadata sheet. | ||
Here, you can build your annotation table by adding [building blocks](/nfdi4plants.knowledgebase/swate/building-blocks) the same way as in the Swate standalone. | ||
|
||
In the "Metadata" sheet, you can fill in general metadata about your investigation, study or assay. | ||
![Image showing Swate integration in ARCitect with focus on "add new annotation table"-button.](@images/swate/swate-alpha-arcitect-newtable.png) | ||
|
||
</TabItem> | ||
<TabItem label="Excel"> | ||
|
||
## Add an annotation table | ||
|
||
In the "New Table" sheet, you can create your annotation table by adding [building blocks](/nfdi4plants.knowledgebase/swate/building-blocks). Your annotation table should consist of an "Input", multiple descriptive building blocks ("Characteristics", "Parameters", "Components") and an "Output". | ||
When you have an empty excel sheet or one hat already contains an annotation table, you can click on the "Create Annotation Table" icon of the navbar of the sidebar. | ||
When the excel sheet contains no annotation table, a new annotation table will be created in the active excel sheet. | ||
When an annotation table already exists in the active excel sheet, a new excel sheet will be created, become active and a new annotation table will be created in that sheet. | ||
|
||
To create an annotation table within ARCitect, add a new table to your assay or study by clicking the plus (+) symbol next to your metadata sheet. Here, you can build your annotation table by adding [building blocks](/nfdi4plants.knowledgebase/swate/building-blocks) the same way as in the Swate standalone. | ||
The new annotation table will be created in the cell that was selected, when you the "Create Annotation Table" icon was clicked. | ||
The newly created annotation table has a size of 1 Input [Source Name] column and row. | ||
|
||
![Image showing Swate integration in ARCitect with focus on "add new annotation table"-button.](@images/swate/swate-alpha-arcitect-newtable.png) | ||
![Image showing add new file option in Swate](@images/swate/swate-excel-add-annotation-table.png) | ||
|
||
</TabItem> | ||
</Tabs> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
make this image WAY smaller. So much dead space
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed