Skip to content

Commit 4ebf46f

Browse files
authored
Merge pull request #381 from microbiomedata/279-amplicon-documentation-update
279 Data portal documentation update
2 parents e3a2de6 + d802312 commit 4ebf46f

8 files changed

Lines changed: 19 additions & 11 deletions

File tree

107 KB
Loading
19.4 KB
Loading
31.4 KB
Loading
37.2 KB
Loading
Binary file not shown.
Binary file not shown.
Binary file not shown.

content/home/src/howto_guides/portal_guide.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ a resource for consistently processed multi-omics data that is
77
integrated to enable search, access, analysis, and download. Open-source
88
bioinformatics workflows are used to process raw multi-omics data and
99
produce interoperable and reusable annotated data from metagenome,
10-
metatranscriptome, metaproteome, metabolome, and natural organic matter
10+
metatranscriptome, metaproteome, metabolome, lipidome, and natural organic matter
1111
characterizations. The NMDC Data Portal offers several search and
1212
navigation components, and data can be downloaded through the graphical
1313
user interface using an ORCiD authentication, with associated download
@@ -135,7 +135,7 @@ more information about that study and that principal investigator.
135135

136136
[![](../_static/images/howto_guides/portal_guide/instrument_name.png)](../_static/images/howto_guides/portal_guide/instrument_name.png)
137137

138-
[![](../_static/images/howto_guides/portal_guide/data_types.png)](../_static/images/howto_guides/portal_guide/data_types.png)
138+
[![](../_static/images/howto_guides/portal_guide/20260901.data_types.png)](../_static/images/howto_guides/portal_guide/20260901.data_types.png)
139139

140140
[![](../_static/images/howto_guides/portal_guide/processing_institution.png)](../_static/images/howto_guides/portal_guide/processing_institution.png)
141141

@@ -197,6 +197,13 @@ the GSC.
197197

198198
### *Search by workflow processing*
199199

200+
## Workflow versions
201+
By default, only the most recent set of results for a sample are shown in the Data Portal.
202+
To display older workflow versions, mark the `Include older workflow executions` checkbox next to the Download button.
203+
If there is a newer workflow result, the older result will indicate that there is a result that supersedes it.
204+
[![](../_static/images/howto_guides/portal_guide/202060901.workflow_versioning.png)](../_static/images/howto_guides/portal_guide/202060901.workflow_versioning.png)
205+
206+
## Metaproteomics analysis category
200207
[![](../_static/images/howto_guides/portal_guide/metap_analysis_category.png)](../_static/images/howto_guides/portal_guide/metap_analysis_category.png)
201208

202209
Workflow results can be searched by metaproteomics analysis category.
@@ -208,11 +215,11 @@ Workflow results can be searched by metaproteomics analysis category.
208215

209216
#### Barplot
210217

211-
[![](../_static/images/howto_guides/portal_guide/bar_plot.png)](../_static/images/howto_guides/portal_guide/bar_plot.png)
218+
[![](../_static/images/howto_guides/portal_guide/20260901.bar_chart.png)](../_static/images/howto_guides/portal_guide/20260901.bar_chart.png)
212219

213220
The barplot on the omics page displays the number of omics processing
214221
runs (not number of samples) for each data type available: organic
215-
matter, metagenomic, metatranscriptomic, proteomic, and metabolomic.
222+
matter, metagenomic, metatranscriptomic, proteomic, metabolomic, lipidomic, and amplicon.
216223
Selecting the bar of a data type will limit the search to just that data
217224
type.
218225

@@ -239,13 +246,11 @@ collection dates are grouped by month. The selected date range will be highlight
239246

240247
#### Upset plot
241248

242-
[![](../_static/images/howto_guides/portal_guide/upset_plot.png)](../_static/images/howto_guides/portal_guide/upset_plot.png)
249+
[![](../_static/images/howto_guides/portal_guide/20260901.upset_plot.png)](../_static/images/howto_guides/portal_guide/20260901.upset_plot.png)
243250

244251
The upset plot on the omics page displays the number of samples that
245252
have various combinations of associated data. The axis at the top
246-
of the plot refers to the different omics types (MG: metagenomic, MT:
247-
metatranscriptomic, MP: metaproteomic, MB: metabolomic, NOM: natural
248-
organic matter) and the dots and lines in the graph below represent the
253+
of the plot refers to the different omics types and the dots and lines in the graph below represent the
249254
combinations of the data types. The numbers and bars on the right
250255
side represent the number of samples searchable in the NMDC data portal
251256
with each corresponding combination of omics data types. Clicking either on the bar
@@ -266,6 +271,7 @@ came from that selected environment.
266271

267272
### Download
268273

274+
269275
### *Individual file*
270276

271277
[![](../_static/images/howto_guides/portal_guide/download_individual_file.png)](../_static/images/howto_guides/portal_guide/download_individual_file.png)
@@ -287,7 +293,8 @@ users to perform bulk downloads on workflow output files. Once samples
287293
of interest are down-selected through query terms, output files from
288294
each NMDC standardized workflow run on those samples are available as
289295
bulk downloads. Users must be logged in with an ORCID account before
290-
downloading data.
296+
downloading data. Bulk download includes a JSON file which describes the files, a README.md file, and
297+
an RO-Crate (14) file which connects files to upstream records.
291298

292299
### *Download metadata*
293300
[![](../_static/images/howto_guides/portal_guide/individual_study_metadata.png)](../_static/images/howto_guides/portal_guide/individual_study_metadata.png)
@@ -301,7 +308,7 @@ sample pages. Metadata can be downloaded in bulk on the main search page for sev
301308
[![](../_static/images/howto_guides/portal_guide/krona_plot.png)](../_static/images/howto_guides/portal_guide/krona_plot.png)
302309

303310
For Reads-Based Taxonomic Analysis results, users can click on the magnifying glass
304-
icon to open up interactive Krona (14) plots.
311+
icon to open up interactive Krona (15) plots.
305312

306313

307314

@@ -344,4 +351,5 @@ icon to open up interactive Krona (14) plots.
344351
> 11. Bateman A, Coin L, Durbin R, Finn RD, Hollich V, Griffiths-Jones S, Khanna A, Marshall M, Moxon S, Sonnhammer ELL, Studholme DJ, Yeats C, Eddy SR. 2004. The Pfam protein families database. Nucleic Acids Res. 32:D138–D141. https://doi.org/10.1093/nar/gkh121.
345352
> 12. Tatusov RL, Galperin MY, Natale DA, Koonin EV. 2000. The COG database: a tool for genome-scale analysis of protein functions and evolution. Nucleic Acids Res. 28:33. https://doi.org/10.1093/nar/28.1.33.
346353
> 13. The Gene Ontology Consortium. 2019. The Gene Ontology resource: 20 years and still GOing strong. Nucleic Acids Res. 47:D330–D338. https://doi.org/10.1093/nar/gky1055.
347-
> 14. Ondov BD, Bergman NH, Phillippy AM. Interactive metagenomic visualization in a Web browser. BMC Bioinformatics. 2011 Sep 30;12:385. doi: 10.1186/1471-2105-12-385. PMID: 21961884; PMCID: PMC3190407.
354+
> 14. Stian Soiland-Reyes, Peter Sefton, Mercè Crosas, Leyla Jael Castro, Frederik Coppens, José M. Fernández, Daniel Garijo, Björn Grüning, Marco La Rosa, Simone Leo, Eoghan Ó Carragáin, Marc Portier, Ana Trisovic, RO-Crate Community, Paul Groth, Carole Goble (2022):Packaging research artefacts with RO-Crate.Data Science 5(2). https://doi.org/10.3233/DS-210053
355+
> 15. Ondov BD, Bergman NH, Phillippy AM. Interactive metagenomic visualization in a Web browser. BMC Bioinformatics. 2011 Sep 30;12:385. doi: 10.1186/1471-2105-12-385. PMID: 21961884; PMCID: PMC3190407.

0 commit comments

Comments
 (0)