You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/2_micro_guides/submitting,_managing_and_updating_submissions.md
+40-56Lines changed: 40 additions & 56 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,76 +12,64 @@ To submit your designs to SynBioHub, follow these steps:
12
12
13
13
2. Click on the **Submit** option, and it will direct you to the Submit page.
14
14
15
-
Now, there are two ways to make your submissions: creating a new collection and then submitting your resource, or submitting to an existing collection.
15
+
3. Drag and drop your file(s) or click **Browse Files** to select the file(s) you want to upload.
16
16
17
-
### 4.1.1 Creating a New Collection
17
+
4. Scroll down the page to find the section where you can choose to create a new collection or use an existing one.
18
18
19
-
1. Select the **New collection** option.
19
+
### 4.1.1 Creating a New Collection
20
20
21
-
2. Fill in the following attributes:
21
+
1. In the **Create New Collection** section, fill in the following attributes:
22
22
23
23
-**Name**: This is the name string that will be assigned to the submission.
24
24
-**Collection Description**: This is the description string that briefly explains your submission.
25
25
-**Collection ID**: This is a user-defined string identifier for the submission and should contain alphanumeric and underscore characters only.
26
26
-**Collection Version**: This is the version string associated with the submission.
27
27
-**Citations** (optional): This is a list of comma-separated PubMed IDs of citations to store with the submission, just for reference. It is an optional attribute.
28
-
-**SBOL/GENBANK/GFF3/FASTA/ZIP file** (OPTIONAL): The file should be of the following types:
|**[SBOL](https://sbolstandard.org/datamodel-about/)**| The Synthetic Biology Open Language (SBOL) has been developed as a standard to support the specification and exchange of biological design information in synthetic biology. |
33
-
|**[GFF3](http://asia.ensembl.org/info/website/upload/gff3.html)**| The GFF (General Feature Format) format consists of one line per feature, each containing 9 columns of data, plus optional track definition lines. |
34
-
|**[FASTA](https://en.wikipedia.org/wiki/FASTA_format)**| In bioinformatics and biochemistry, the FASTA format is a text-based format for representing either nucleotide sequences or amino acid (protein) sequences, in which nucleotides or amino acids are represented using single-letter codes. The format also allows for sequence names and comments to precede the sequences. The format originates from the FASTA software package but has now become a near-universal standard in the field of bioinformatics. |
35
-
|**[zip](https://en.wikipedia.org/wiki/Zip_(file_format))**| ZIP is an archive file format that supports lossless data compression. A ZIP file may contain one or more files or directories that may have been compressed. |
36
-
37
-
To submit a file, you must have already submitted the collection. Once you do, you can click **Submit**, and it will submit to the collection just created.
28
+
-**Handler**: Select a handler for processing the submission. By default, only one option is provided, but more handlers can be added via [submit plugins](https://github.com/SynBioHub/Plugin-Submit-Excel-Library).
29
+
-**Overwrite Existing Collection**: You can choose to overwrite the existing objects in the collection, removing all the existing objects and adding new ones, or keep the old resources and add the new ones.
38
30
39
-
-**Handler**: You also need to select a handler. By default, only one option is provided, but more handlers can be added via [submit plugins](https://github.com/SynBioHub/Plugin-Submit-Excel-Library).
40
-
- Finally, you have an option to overwrite the existing objects in that collection, i.e., removing all the existing objects in the collection and adding new ones, or keeping the old resources and adding the new ones.
41
-
42
-
3. Finally, click on **Submit**.
31
+
2. Click **Create** to finalize the new collection and submit your file(s).
43
32
44
33
### 4.1.2 Submitting to an Existing Collection
45
34
46
-
1.Select the **add to existing collection** option.
35
+
1.In the **Use Existing Collection** section, use the dropdown menu to select the collection to which you want to add your submission.
47
36
48
-
2.Then, select your desired collection to which you want to add your submission from the dropdown menu.
37
+
2.Optionally, choose to overwrite the existing objects in the collection, removing all the existing objects and adding new ones, or keep the old resources and add the new ones.
49
38
50
-
3.Subsequently, upload the files you want to submit. The file should be of the following types:
| SBOL | The Synthetic Biology Open Language (SBOL) has been developed as a standard to support the specification and exchange of biological design information in synthetic biology. To know more about SBOL, visit [this page](https://sbolstandard.org/datamodel-about/). |
55
-
| Annotated zip | ZIP is an archive file format that supports lossless data compression. A ZIP file may contain one or more files or directories that may have been compressed. To know more about zip, visit [this page](https://en.wikipedia.org/wiki/Zip_(file_format)). |
56
-
| GFF3 | The GFF (General Feature Format) format consists of one line per feature, each containing 9 columns of data, plus optional track definition lines. To know more about GFF3, click [here](http://asia.ensembl.org/info/website/upload/gff3.html). |
57
-
| FASTA | In bioinformatics and biochemistry, the FASTA format is a text-based format for representing either nucleotide sequences or amino acid (protein) sequences, in which nucleotides or amino acids are represented using single-letter codes. The format also allows for sequence names and comments to precede the sequences. The format originates from the FASTA software package but has now become a near-universal standard in the field of bioinformatics. To know more about FASTA file format, click [here](https://en.wikipedia.org/wiki/FASTA_format). |
58
-
| Zip | ZIP is an archive file format that supports lossless data compression. A ZIP file may contain one or more files or directories that may have been compressed. To know more about zip, visit [this page](https://en.wikipedia.org/wiki/Zip_(file_format)). |
41
+
### 4.1.3 Supported File Formats
59
42
60
-
4. Finally, you have an option to overwrite the existing objects in that collection, i.e., removing all the existing objects in the collection and adding new ones, or keeping the old resources and adding the new ones.
43
+
The following file formats are supported for submission:
|**[SBOL](https://sbolstandard.org/datamodel-about/)**| The Synthetic Biology Open Language (SBOL) has been developed as a standard to support the specification and exchange of biological design information in synthetic biology. |
48
+
|**[GFF3](http://asia.ensembl.org/info/website/upload/gff3.html)**| The GFF (General Feature Format) format consists of one line per feature, each containing 9 columns of data, plus optional track definition lines. |
49
+
|**[FASTA](https://en.wikipedia.org/wiki/FASTA_format)**| In bioinformatics and biochemistry, the FASTA format is a text-based format for representing either nucleotide sequences or amino acid (protein) sequences, in which nucleotides or amino acids are represented using single-letter codes. The format also allows for sequence names and comments to precede the sequences. |
50
+
|**[zip](https://en.wikipedia.org/wiki/Zip_(file_format))**| ZIP is an archive file format that supports lossless data compression. A ZIP file may contain one or more files or directories that may have been compressed. |
63
51
64
52
## 4.2 Managing Submissions
65
53
66
54
1. Navigate to SynBioHub's home page.
67
55
68
-
2. Click on **manage submissions**. On this page, you will be able to see collections broadly divided into two categories. The first one is **public collections**, which you have created and only you have access to them, and the second one is **private collections**, to which all users have access.
56
+
2. Click on **Manage Submissions**. On this page, you will see collections broadly divided into two categories: **Public Collections**, which are accessible to all users, and **Private Collections**, which are accessible only to you.
69
57
70
58
3. You can view your collection by clicking on the collection name.
71
59
72
-
4. To make your collection public, click on the collections you want (using the checkboxes on the left-hand side), then click on**Publish**. This will enable other users to view your collection and its contents.
60
+
4. To make your collection public, select the collections you want (using the checkboxes on the left-hand side), then click **Publish**. This will enable other users to view your collection and its contents.
73
61
74
-
5. To delete your collection, click on **Remove**. This will remove the collection as well as the resources contained in that specific collection, namely promoters, activators, modules, components, engineered regions, etc.
62
+
5. To delete your collection, click **Remove**. This will remove the collection as well as the resources contained in that specific collection, such as promoters, activators, modules, components, engineered regions, etc.
75
63
76
64
## 4.3 Updating Submissions
77
65
78
-
1. On the submit page, select the collection you want to submit your design to.
66
+
1. On the Submit page, select the collection you want to submit your design to.
79
67
80
68
2. Select the design that you want to submit.
81
69
82
70
3. You may choose to *overwrite the existing objects* in a collection.
83
71
84
-
4. Then, click on **Submit**.
72
+
4. Then, click **Submit**.
85
73
86
74
## 4.4 Editing a Submission
87
75
@@ -91,36 +79,32 @@ To edit your submissions, follow these steps:
91
79
92
80
2. Select the collection that you want to edit.
93
81
94
-
3. First of all, you can edit the **name** and **description** of the record.
95
-
96
-
4. Then, you can add a **source** for your record.
82
+
3. Edit the **name** and **description** of the record.
97
83
98
-
5. Subsequently, you may add a brief description for your record. This may contain details that can be described briefly about that particular record.
84
+
4. Add a **source**for your record.
99
85
100
-
6. As you scroll down, you will find a clickable menu titled **details**. Under this section, you can find the following options which you can edit. They are as follows:
86
+
5. Provide a brief description for your record.
101
87
102
-
-**Add Description**: Here, you can provide a detailed description for your record.
103
-
-**Add notes**: In this section, you can provide additional notes for explaining your record.
88
+
6. Under the **Details** section, you can edit the following:
104
89
105
-
Here you can use basic text formatting options, such as **bold**, *italic*, and underlining. Also, you may include an image as well as links with the use of HTML tags.
90
+
-**Add Description**: Provide a detailed description for your record.
91
+
-**Add Notes**: Include additional notes explaining your record. You can use basic text formatting options, such as **bold**, *italic*, and underlining. You may also include images and links using HTML tags.
92
+
-**Source**: Enter links referring to the origin of your record.
93
+
-**Citations**: Add PubMed IDs separated by commas to cite research papers.
106
94
107
-
-**Source**: Here, you can enter various links referring to the place from where your record has been generated.
108
-
-**Citations**: You just need to add PubMed IDs separated by commas, using which you can cite several research papers.
95
+
7. Under the **Other Properties** section, you can add/edit various properties.
109
96
110
-
7. Then, we have the section titled **other properties**. Under this section, you can add/edit various properties, other than Synbiohub#ownedBy and Synbiohub#topLevel.
97
+
8. In the **Attachments**section, you can upload or look up attachments:
111
98
112
-
8. Finally, we have the attachments section. Herein, you can upload as well as look up an attachment. The process for both options is described in detail as follows:
113
-
114
-
1.**Upload attachments**: To upload an attachment, you just need to click the **select file(s)** option, and a popup shall appear. Now you need to select the attachments from your machine based on your convenience.
115
-
2.**Lookup attachment**: Under this option, you can search for attachments. For this, you need to provide a URL for the attachment as well as its name. Then you need to select the type of attachment for which you want to search. The types are as follows: .nib, 2bit, A2M, ABI, etc...
99
+
-**Upload Attachments**: Click **Select File(s)** to upload attachments from your machine.
100
+
-**Lookup Attachment**: Provide a URL and name for the attachment, and select its type (e.g., .nib, 2bit, A2M, ABI, etc.).
116
101
117
102
## 4.5 Add to an Existing Collection
118
103
119
-
On some record pages, you might find an option titled **add to an existing collection**. Using this option, you can add the record you are currently viewing to a collection that is already there. For that, simply follow these steps:
104
+
On some record pages, you might find an option titled **Add to an Existing Collection**. Using this option, you can add the record you are currently viewing to an existing collection. Follow these steps:
105
+
106
+
1. Click **Add to Collection**. This will direct you to a page with a dropdown menu.
120
107
121
-
- Click **add to collection**. This will direct you to a page consisting of a dropdown menu.
122
-
- Then, click on that dropdown menu. This will contain a list of collections that are already existing, and the record which you are currently viewing can be added to it.
123
-
- Then, select the collection as per your convenience from the dropdown menu.
124
-
- Finally, click **add to collection**.
108
+
2. Select the desired collection from the dropdown menu.
125
109
126
-
This shall add the record or the collection you are currently viewing to the collection you have selected.
110
+
3. Click **Add to Collection**to finalize the addition.
0 commit comments