Skip to content

Commit 9a50dc5

Browse files
authored
Merge pull request #510 from jliermann/rework_domains
Rework domains
2 parents 46344be + 734c42c commit 9a50dc5

34 files changed

Lines changed: 1971 additions & 1841 deletions

docs/00_intro/00_intro.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,10 @@ At least and most importantly a loss of previously acquired data is always an [i
3030
width="max(500px, 50%)"
3131
/>
3232

33-
The NFDI4Chem knowledge base provides information and recommendations to digitalise all key steps of chemical research to support scientists in their efforts to collect, store, process, analyse, publish, and reuse research data.
33+
The NFDI4Chem knowledge base provides information and recommendations to digitalise all key steps of chemical research to support scientists in their efforts to collect, store, process, analyse, publish, and reuse research data.
3434

3535
Actions to [promote Open Science and Research Data Management](https://riojournal.com/article/55852/) in accordance with the FAIR data principles are presented by everyday users and range from planning and implementation to publication and reuse.
3636

37-
3837
:::info Guidance for getting started:
3938
The knowledge base offers different points of entry that help you in navigating the site and simplify the targeted search for information. Start with the search (Ctrl+K) or use the main navigation bar for topics like domains, roles, handling data articles, smartlab, or publication of data.
4039
:::
@@ -89,6 +88,6 @@ In this category on data publishing you will find all the important information
8988
text={"Data Publishing"}
9089
/>
9190

92-
:::Acknowlegdements
91+
:::info Acknowledgements
9392
This knowledge base is inspired by [RDMkit](https://rdmkit.elixir-europe.org/index.html) but has been tailored specifically towards Chemists as end-users.
9493
:::

docs/00_intro/10_fair.mdx

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: "FAIR Data Principles"
33
slug: "/fair"
44
---
55

6-
# FAIR Data Principles
7-
86
![FAIR Data](/img/topics/FAIR_data_principles.png)
97

108
Image Attribution: SangyaPundir, [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0).
@@ -30,19 +28,19 @@ Researchers — and the computers working on their behalf — must be able to fi
3028

3129
### F1. (meta)data are assigned a globally unique and persistent identifier {#f1}
3230

33-
A globally unique and [persistent identifier (PID)](/docs/pid) helps both machines and humans find the data in the first place. These PIDs are essential for research as they guarantee the availability of the associated resource, in this case a dataset. The registry services that make these identifiers available work to maintain the link to the resource, thus avoiding dead links.
31+
A globally unique and [persistent identifier (PID)](/docs/pid) helps both machines and humans find the data in the first place. These PIDs are essential for research as they guarantee the availability of the associated resource, in this case a dataset. The registry services that make these identifiers available work to maintain the link to the resource, thus avoiding dead links.
3432

3533
A common example of a citable PID is the Digital Object Identifier, or [DOI](https://doi.org/10.1000/182). As with many journals, scientific data repositories often assign a DOI automatically. For example, both the [The Cambridge Structural Database (CSD)](https://www.ccdc.cam.ac.uk/solutions/csd-system/components/csd/) and the [Chemotion Repository](https://www.chemotion-repository.net/) assign DOIs to each dataset deposited. Researchers must be aware of this option when searching for a suitable repository (e.g. at [re3data](https://www.re3data.org/)), while repositories should offer this service.
3634

3735
### F2. data are described with rich metadata (defined by R1 below) {#f2}
3836

3937
Data need to be sufficiently described in order to make them both findable and reusable. Hence, the specific focus here lies on making the (meta)data findable by using rich discovery [metadata](/docs/metadata) in a standardized format and allowing computers and humans to quickly understand the dataset’s contents. This is an essential component in the plurality of metadata described by [R1](#r1) below. This information may include, but is not limited to:
4038

41-
- the context on what the dataset is, how it was generated, and how it can be interpreted,
42-
- the data quality,
43-
- licensing and (re)use agreements,
44-
- what other data may be related (linked via its PID), and
45-
- associated journal publications and their DOI.
39+
- the context on what the dataset is, how it was generated, and how it can be interpreted,
40+
- the data quality,
41+
- licensing and (re)use agreements,
42+
- what other data may be related (linked via its PID), and
43+
- associated journal publications and their DOI.
4644

4745
Repositories should provide a fillable [application profile](https://en.wikipedia.org/wiki/Application_profile) that allows researchers to give extensive and precise information on their deposited datasets. For example, the Chemotion Repository uses and [RADAR4Chem](https://www.nfdi4chem.de/index.php/2650-2/), among others, the [Datacite Metadata Schema](http://doi.org/10.5438/0012) to build its application profile, a schema specifically created for the publication and citation of research data. These include an assortment of mandatory, recommended, and optional metadata properties, allowing for a rich description of the deposited dataset. For those publishing data, always keep in mind: the more information provided, the better.
4846

@@ -106,17 +104,17 @@ Many of the previous points lead to one key aspect of data sharing: data reusabi
106104

107105
Related to [F2](#f2):
108106

109-
- What the dataset contains, including whether the data is raw and/or processed
110-
- How the data was processed
111-
- How the data can be reused
112-
- Who created the data
113-
- Date of creation
114-
- Variable names
115-
- Standard methods used
116-
- Scope of the data and project
117-
- Lab conditions
118-
- Any limitations to the data
119-
- Software and versions used for acquisition and processing.
107+
- What the dataset contains, including whether the data is raw and/or processed
108+
- How the data was processed
109+
- How the data can be reused
110+
- Who created the data
111+
- Date of creation
112+
- Variable names
113+
- Standard methods used
114+
- Scope of the data and project
115+
- Lab conditions
116+
- Any limitations to the data
117+
- Software and versions used for acquisition and processing.
120118

121119
An important piece of information for chemical data are [machine-readable chemical structures](/docs/machine-readable_chemical_structures). This should be included within the dataset and/or metadata and aids computers in finding the correct data in their queries.
122120

@@ -140,8 +138,8 @@ Where required, format converters should be linked in the dataset’s metadata.
140138

141139
## Sources and further information
142140

143-
- [FORCE 11: FAIR Data Principles](https://www.force11.org/group/fairgroup/fairprinciples)
144-
- [Go-FAIR initiative: FAIR Principles](https://www.go-fair.org/fair-principles/)
145-
- [TIB Blog: The FAIR Data Principles for Research Data](https://blogs.tib.eu/wp/tib/2017/09/12/the-fair-data-principles-for-research-data/)
146-
- [FAIRsFAIR: How to be FAIR with your data. A teaching and training handbook for higher education institutions](https://doi.org/10.5281/zenodo.6674301) & [Engelhardt et al. (book version)](https://doi.org/10.17875/gup2022-1915) & [Gitbook version](https://fairsfair.gitbook.io/fair-teaching-handbook)
147-
- [Checklist: How FAIR are your data?](https://doi.org/10.5281/zenodo.1065991) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1065991.svg)](https://doi.org/10.5281/zenodo.1065991)
141+
- [FORCE 11: FAIR Data Principles](https://www.force11.org/group/fairgroup/fairprinciples)
142+
- [Go-FAIR initiative: FAIR Principles](https://www.go-fair.org/fair-principles/)
143+
- [TIB Blog: The FAIR Data Principles for Research Data](https://blogs.tib.eu/wp/tib/2017/09/12/the-fair-data-principles-for-research-data/)
144+
- [FAIRsFAIR: How to be FAIR with your data. A teaching and training handbook for higher education institutions](https://doi.org/10.5281/zenodo.6674301) & [Engelhardt et al. (book version)](https://doi.org/10.17875/gup2022-1915) & [Gitbook version](https://fairsfair.gitbook.io/fair-teaching-handbook)
145+
- [Checklist: How FAIR are your data?](https://doi.org/10.5281/zenodo.1065991) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1065991.svg)](https://doi.org/10.5281/zenodo.1065991)

docs/10_domains/00_domain_guide.mdx

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,4 @@ import domains from "@site/src/data/domains";
99

1010
Looking for information on managing research data in chemistry? Choose your chemical domain and find discipline-specific help on research data management.
1111

12-
:::info Info:
13-
The domain-specific profiles provide an overview of the individual RDM steps. The following topics are presented in detail:
14-
15-
- summary of domain-specific profile
16-
- type of experiments
17-
- planning of experiments
18-
- documentation of experiments
19-
- data producing methods (including a table with recommendations on interoperable open file formats)
20-
- data analysis
21-
- publication of research data
22-
:::
23-
24-
Click on a button below to get started with your chemical domain. The domain-specific profiles will be continuously updated based on new developments and feedback.
25-
2612
<Features featureList={domains} />

docs/10_domains/10_analytical_chemistry.mdx

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import ElnFinder from "@site/src/components/eln/ElnFinder.js";
1212

1313
## Introduction
1414

15-
Although analytical chemistry is one of the oldest branches of chemistry, it continues to evolve. New methods and technologies are constantly being developed. Providing the tools and techniques needed to identify and quantify the chemical constituents of a sample, analytical chemistry is a cornerstone of both academia and industry. It is essential for a wide range of applications, from environmental monitoring to drug discovery.
15+
Providing the tools and techniques needed to identify and quantify the chemical constituents of a sample, analytical chemistry is a cornerstone of both academia and industry. It is essential for a wide range of applications, from environmental monitoring to drug discovery.
1616

1717
Despite the diversity of analytical methods, a common denominator is the large amount of data generated by instrumental methods. This data must be processed and interpreted to extract meaningful information. This makes analytical chemistry a challenging field for research data management.
1818

@@ -22,25 +22,23 @@ Unlike some other areas of chemistry, most research data in analytical chemistry
2222

2323
Techniques like mass spectrometry, chromatography, and spectroscopy generate complex data consisting of raw data files, metadata, and processed data. Raw data files are often proprietary and require specialised software to open and interpret. Metadata is crucial for understanding experimental conditions and parameters. Processed data can range from simple peak lists to complex multivariate models.
2424

25-
Some open data formats are available for specific data types, such as mass spectrometry data in the [mzML format](https://www.psidev.info/mzML). The [JCAMP-DX format](https://iupac.org/what-we-do/digital-standards/jcamp-dx/) is used for optical spectroscopy data. This format is also suitable for NMR spectroscopy data, but with some major limitations. For chromatography or combined chromatography-mass spectrometry data the situation is more complex as many vendors have their own proprietary formats.
25+
Some open data formats are available for specific data types, such as mass spectrometry data in the [mzML format](https://www.psidev.info/mzML). The [JCAMP-DX format](https://iupac.org/what-we-do/digital-standards/jcamp-dx/) is used for optical spectroscopy data. This format is also suitable for NMR spectroscopy data, but with some major limitations. For chromatography or combined chromatography-mass spectrometry data, the situation is more complex, as many vendors have their own proprietary formats.
2626

2727
## ELNs and Other Tools
2828

29-
For effective data management, software tools should be selected in a uniform manner within a project or research group with the aim to [organize](/docs/data_organisation)
30-
and streamline workflows. This involves establishing clear usage guidelines, including metadata templates drawn from minimum information standards for a given method, where available.
31-
These should be outlined in a [data management plan (DMP)](/docs/dmp) for each project. NFDI4Chem provides an [RDMO template](https://rdmo.nfdi4chem.de/) specifically tailored to the needs of chemists.
29+
For effective data management, tools should be selected at project or group level based on workflows. Because workflows are often method-specific, usage guidelines and metadata templates should be defined and documented in a [data management plan (DMP)](/docs/dmp). NFDI4Chem provides an [RDMO template](https://rdmo.nfdi4chem.de/) tailored to chemistry.
3230

33-
General chemistry ELNs can typically be used for analytical chemistry data and may be well suited to your research topic. However, there are also specialised tools that are tailored to the needs of analytical chemists. These tools often include features for managing instrument data, processing raw data files and visualising results. They may also include tools for chemometric analysis.
31+
General chemistry ELNs can typically be used for analytical chemistry data and may be well suited to your research topic. However, there are also specialised tools tailored to the needs of analytical chemists. These tools often include features for managing instrument data, processing raw data files, and visualising results. They may also include tools for chemometric analysis.
3432

3533
<ElnFinder subDisc="Analytical chemistry" />
3634

3735
## Publishing Data
3836

3937
Data from analytical chemistry can be published on several platforms, depending on the research subject and data type.
4038

41-
If the analytical data have a more supporting role in a larger study it may be appropriate to publish the data in a general data repository. If the research focuses more on the analytical method itself, it may be more appropriate to publish the data in a specialised repository.
39+
If the analytical data have a supporting role in a larger study, it may be appropriate to publish them in a general data repository. If the research focuses on the analytical method itself, a specialised repository may be more appropriate.
4240

43-
General data repositories include [Zenodo](https://zenodo.org/) or [RADAR4Chem](https://radar.products.fiz-karlsruhe.de/de/radarabout/radar4chem). For analytical data in context with synthetic chemistry data, [Chemotion Repository](https://chemotion-repository.de/) might also be a suitable option.
41+
General data repositories include [RADAR4Chem](https://radar.products.fiz-karlsruhe.de/de/radarabout/radar4chem) or [Zenodo](https://zenodo.org/). For analytical data in context with synthetic chemistry data, [Chemotion Repository](https://chemotion-repository.de/) might also be a suitable option.
4442

4543
For method-specific data, several specialised repositories are available. A few examples include:
4644

0 commit comments

Comments
 (0)