Skip to content

Commit e17ffb8

Browse files
authored
Merge pull request #493 from jliermann/main
Component refactoring, LBE, DMP
2 parents 1344088 + 3293991 commit e17ffb8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+1900
-1449
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,6 @@ yarn.lock
2626
docusaurus.config.js
2727
.Rproj.user
2828
knowledge_base.Rproj
29-
.vscode
29+
.vscode
30+
31+
article_count.md

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@
44

55
This repo is the core of the [NFDI4Chem knowledge base](https://knowledgebase.nfdi4chem.de).
66

7-
## Documentation
7+
[![Crowdin](https://badges.crowdin.net/nfdi4chem-knowledge-base/localized.svg)](https://crowdin.com/project/nfdi4chem-knowledge-base) [![Localisation Workflow](https://github.com/NFDI4Chem/knowledge_base/actions/workflows/localisation.yml/badge.svg)](https://github.com/NFDI4Chem/knowledge_base/actions/workflows/localisation.yml)
88

9-
- [Getting started](./readme/getting_started.md)
10-
- [Localisation](./readme/localisation.md)
11-
- [Advanced stuff](./readme/advanced.md)
12-
- [Local testing](./readme/testing.md)
9+
## Documentation
1310

14-
[![Crowdin](https://badges.crowdin.net/nfdi4chem-knowledge-base/localized.svg)](https://crowdin.com/project/nfdi4chem-knowledge-base) [![Localisation Workflow](https://github.com/NFDI4Chem/knowledge_base/actions/workflows/localisation.yml/badge.svg)](https://github.com/NFDI4Chem/knowledge_base/actions/workflows/localisation.yml)
11+
* [Getting started](./readme/getting_started.md)
12+
* [Localisation](./readme/localisation.md)
13+
* [Advanced stuff](./readme/advanced.md)
14+
* [Custom components](./readme/custom.md)
15+
* [Local testing](./readme/testing.md)
1516

1617
## Acknowledgments
1718

docs/00_intro/00_intro.mdx

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,14 @@ slug: "/intro"
44
id: "intro"
55
---
66

7-
import useBaseUrl from '@docusaurus/useBaseUrl';
8-
import IntroButton from '@site/src/components/IntroButton.js';
7+
import FeatureButton from "@site/src/components/features/FeatureButton.js";
8+
import FloatImage from "@site/src/components/commons/FloatImage.js";
99

10-
<img alt="Data LifeCycle" src={useBaseUrl('/img/Intro/DataLifeCycle_KB.svg')} width="500" align="right" vspace="10" hspace="10"/>
10+
<FloatImage
11+
alt="Data LifeCycle"
12+
url="/img/Intro/DataLifeCycle_KB.svg"
13+
width="max(500px, 50%)"
14+
/>
1115

1216
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. This knowledge base is inspired by [RDMkit](https://rdmkit.elixir-europe.org/index.html) but has been tailored specifically towards Chemists as end-users.
1317

@@ -16,13 +20,13 @@ Actions to [promote Open Science and Research Data Management](https://riojourna
1620
## Why is RDM important for chemistry?
1721

1822
:::danger Notice:
19-
Research Data Management in chemistry is currently not systematically organised and individual solutions of single institutions lead to low visibility, accessibility, and usability of research results. The added value of preserving and researching scientific data in chemistry is particularly high because the significance of the data is often immortal, hence, older data can be reused for current investigations. In most cases, it is even mandatory to be able to access older data, since experimental data or complex simulation data in particular can only be regenerated with great effort.
23+
Research Data Management in chemistry is currently not systematically organised and individual solutions of single institutions lead to low visibility, accessibility, and usability of research results. The added value of preserving and researching scientific data in chemistry is particularly high because the significance of the data is often immortal, hence, older data can be reused for current investigations. In most cases, it is even mandatory to be able to access older data, since experimental data or complex simulation data in particular can only be regenerated with great effort.
2024
:::
2125

2226
Main motivations for RDM in chemistry are:
2327

2428
- to prevent the loss of data and ensure data security
25-
- to warrant long-term availability of research data
29+
- to warrant long-term availability of research data
2630
- to accelerate retrieval of data and information
2731
- to enhance transparency, reproducibility allow verifiability of research findings
2832
- to boost sustainability by saving time and resources
@@ -40,28 +44,48 @@ The knowledge base offers different points of entry that help you in navigating
4044

4145
The domain pages present an exemplary workflow for different chemistry disciplines along the research data life cycle. Multiple domains are illustrated in a user profile. Guidelines are provided for all digitisation steps involved and domain-specific best practices for FAIR data are given. Find out how to apply good RDM and FAIR science in the context of your own specific discipline!
4246

43-
<IntroButton url={"/docs/domain_guide"} imgUrl={"/img/nfdi4chem_Domains.svg"} text={"Domains"} />
47+
<FeatureButton
48+
url={"/docs/domain_guide"}
49+
imgUrl={"/img/nfdi4chem_Domains.svg"}
50+
text={"Domains"}
51+
/>
4452

4553
### Role-specific information
4654

4755
The role pages focus on the motivation for role-specific requirements and answer the questions why RDM is important and how it can be implemented. Get a fast impression of all important RDM information related to your role!
4856

49-
<IntroButton url={"/docs/role_guide/"} imgUrl={"/img/nfdi4chem_Roles.svg"} text={"Roles"} />
57+
<FeatureButton
58+
url={"/docs/role_guide/"}
59+
imgUrl={"/img/nfdi4chem_Roles.svg"}
60+
text={"Roles"}
61+
/>
5062

5163
### Handling data
5264

5365
The handling data section explains common problems and challenges regarding RDM. Problematic aspects of data handling are considered, starting with the creation of data management plans, data organisation and data documentation. Moreover, aspects on data storage and archiving are also covered.
5466

55-
<IntroButton url={"/docs/data_guide/"} imgUrl={"/img/nfdi4chem_Handling_Data.svg"} text={"Handling Data"} />
67+
<FeatureButton
68+
url={"/docs/data_guide/"}
69+
imgUrl={"/img/nfdi4chem_Handling_Data.svg"}
70+
text={"Handling Data"}
71+
/>
5672

5773
### Smartlab
5874

5975
To enable fully digital workflows in chemistry, the development and provision of a modular virtual laboratory environment with concepts, services and software (smartlab) is essential. Electronic lab notebooks are an important part of the smartlab, as well as integration of analytical instrumentation and data transfer to repositories.
6076

61-
<IntroButton url={"/docs/smartlab"} imgUrl={"/img/nfdi4chem_SmartLab.svg"} text={"Smartlab"} />
77+
<FeatureButton
78+
url={"/docs/smartlab"}
79+
imgUrl={"/img/nfdi4chem_SmartLab.svg"}
80+
text={"Smartlab"}
81+
/>
6282

6383
### Data Publishing
6484

65-
In this category on data publishing you will find all the important information on the topic of data publishing. This includes the motivation to publish research data, paths to publish data, recommendations for research data repositories to be used, best practices and aspects of machine actionability.
85+
In this category on data publishing you will find all the important information on the topic of data publishing. This includes the motivation to publish research data, paths to publish data, recommendations for research data repositories to be used, best practices and aspects of machine actionability.
6686

67-
<IntroButton url={"/docs/data_publishing"} imgUrl={"/img/nfdi4chem_Data_Publication.svg"} text={"Data Publishing"} />
87+
<FeatureButton
88+
url={"/docs/data_publishing"}
89+
imgUrl={"/img/nfdi4chem_Data_Publication.svg"}
90+
text={"Data Publishing"}
91+
/>

docs/00_intro/20_data_life_cycle.mdx

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,17 @@ title: "Data Life Cycle"
33
slug: "/data_life_cycle"
44
---
55

6-
import useBaseUrl from '@docusaurus/useBaseUrl';
6+
import FloatImage from "@site/src/components/commons/FloatImage.js";
77

88
# Research Data Life Cycle
99

1010
## Introduction
1111

12-
<img alt="Data LifeCycle" src={useBaseUrl('/img/Intro/DataLifeCycle_KB.svg')} width="500" align="right" vspace="50" hspace="10"/>
12+
<FloatImage
13+
alt="Data LifeCycle"
14+
url="/img/Intro/DataLifeCycle_KB.svg"
15+
width="max(500px, 50%)"
16+
/>
1317

1418
In scientific work, the assurance of [good research practice](https://doi.org/10.5281/zenodo.3923602) is the highest imperative.
1519

@@ -33,17 +37,16 @@ Moreover, **quality assurance** is important at this phase. Check, validate and
3337

3438
## Phase 4: Analysis
3539

36-
In the 4th phase, as the name suggests, the focus is on the **analysis and interpretation of the data**. After analysing the data, the data should be evaluated. You should also consider **sharing the data** with colleagues in a closed and secure environment like on a project or working group level. Secure environments for sharing data are often provided by universities or federal states through Sync&share solutions. Consult your local research data team about this.
37-
38-
Before sharing data, you should check whether the data is subject to **copyright protection or other protective rights**.
40+
In the 4th phase, as the name suggests, the focus is on the **analysis and interpretation of the data**. After analysing the data, the data should be evaluated. You should also consider **sharing the data** with colleagues in a closed and secure environment like on a project or working group level. Secure environments for sharing data are often provided by universities or federal states through Sync&share solutions. Consult your local research data team about this.
3941

42+
Before sharing data, you should check whether the data is subject to **copyright protection or other protective rights**.
4043

4144
## Phase 5: Disclosure/ Publication
4245

43-
During this exchange and the associated reflections on the data, you should think about archiving and using the data in scientific publications. If you are not aware of any **criteria for archiving** and no criteria are specified in your working group or institute, decision-making guides such as the [“5 steps to decide what data to keep”](https://www.dcc.ac.uk/guidance/how-guides/five-steps-decide-what-data-keep) outlined by the DCC can help. Based on the established criteria, it is determined which of the collected raw data should be archived and which should be deliberately deleted.
46+
During this exchange and the associated reflections on the data, you should think about archiving and using the data in scientific publications. If you are not aware of any **criteria for archiving** and no criteria are specified in your working group or institute, decision-making guides such as the [“5 steps to decide what data to keep”](https://www.dcc.ac.uk/guidance/how-guides/five-steps-decide-what-data-keep) outlined by the DCC can help. Based on the established criteria, it is determined which of the collected raw data should be archived and which should be deliberately deleted.
4447

4548
In addition to the criteria, the migration of the data into **suitable [formats](/docs/format_standards) and onto suitable media** is important for archiving the data. In this step, the data should again be enriched with metadata so that it can be understood in the future without further knowledge about the data.
46-
In addition to archiving, the [publication](/docs/data_publishing) of the data plays a special role. Many research funders expect the data to be published if there are no special reasons not to do so, such as a non-disclosure agreement or the inclusion of personal data. A **chemistry-specific or chemistry-related [repository](/docs/repositories)** such as the [Chemotion Repository](https://www.chemotion-repository.net/), [NOMAD](https://nomad-lab.eu/services/repo-arch), or [MassBank](https://massbank.eu/MassBank/) is recommended for the publication of data. An overview of repositories can be found, for example, at [re3data.org](https://www.re3data.org/) or [fairsharing.org](https://fairsharing.org/). re3data.org allows you to filter repositories according to certain criteria such as the assignment of a persistent identifier or access.
49+
In addition to archiving, the [publication](/docs/data_publishing) of the data plays a special role. Many research funders expect the data to be published if there are no special reasons not to do so, such as a non-disclosure agreement or the inclusion of personal data. A **chemistry-specific or chemistry-related [repository](/docs/repositories)** such as the [Chemotion Repository](https://www.chemotion-repository.net/), [NOMAD](https://nomad-lab.eu/services/repo-arch), or [MassBank](https://massbank.eu/MassBank/) is recommended for the publication of data. An overview of repositories can be found, for example, at [re3data.org](https://www.re3data.org/) or [fairsharing.org](https://fairsharing.org/). re3data.org allows you to filter repositories according to certain criteria such as the assignment of a persistent identifier or access.
4750
Data publishing often takes place at certain milestones, for example, in combination with a text publication or at the end of a project. The **final version of the data management plan** is also required at the end of a project.
4851

4952
## Phase 6: Re-use
@@ -52,7 +55,7 @@ In the re-use phase, you or others conduct further research on how the data can
5255

5356
In order to return these data to the cycle, it is important that these data are described in detail with metadata, that proper documentation has been carried out in the form of a DMP, and that the data are citable.
5457

55-
What is the potential of your data?
58+
What is the potential of your data?
5659

5760
## Sources and further information
5861

@@ -61,4 +64,4 @@ What is the potential of your data?
6164
- [Review of data management lifecycle models](https://researchportal.bath.ac.uk/en/publications/review-of-data-management-lifecycle-models)
6265
- [DCC: 5 steps to decide what data to keep](https://www.dcc.ac.uk/guidance/how-guides/)
6366
- German: [Überblick zum Management von Forschungsdaten (FDM I) = Research Data Management - An Overview](https://doi.org/10.18154/RWTH-2019-06489)
64-
- German: [Forschungsdaten.info: Informieren und Planen](https://www.forschungsdaten.info/themen/informieren-und-planen/datenlebenszyklus/ )
67+
- German: [Forschungsdaten.info: Informieren und Planen](https://www.forschungsdaten.info/themen/informieren-und-planen/datenlebenszyklus/)

docs/10_domains/00_domain_guide.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ slug: "/domain_guide"
44
id: "domains_guide"
55
---
66

7-
import N4CFeatures from '/src/components/N4CFeatures.js';
7+
import Features from "@site/src/components/features/Features";
8+
import domains from "./domains";
89

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

@@ -18,8 +19,8 @@ The domain-specific profiles provide an overview of the individual RDM steps. Th
1819
- data producing methods (including a table with recommendations on interoperable open file formats)
1920
- data analysis
2021
- publication of research data
21-
:::
22+
:::
2223

2324
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.
2425

25-
<N4CFeatures feature="domains" />
26+
<Features featureList={domains} />

docs/10_domains/10_analytical_chemistry.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ nfdi4chem-id: dac
44
slug: "/analytical_chemistry"
55
---
66

7-
import { LbeChip } from "@site/src/components/lbe/LbeElements.js";
7+
import LbeChip from "@site/src/components/commons/LbeChip.js";
88
import ElnFinder from "@site/src/components/eln/ElnFinder.js";
99

1010
<LbeChip title="analytical chemistry" />
@@ -44,12 +44,12 @@ General data repositories include [Zenodo](https://zenodo.org/) or [RADAR4Chem](
4444

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

47-
- [MassBank EU](https://massbank.eu/)
48-
A field-specific ecosystem of databases and tools for mass spectrometry reference spectra.
49-
- [MetaboLights](https://www.ebi.ac.uk/metabolights/)
50-
A repository for metabolomic studies.
51-
- [nmrXiv](https://nmrxiv.org/)
52-
A repository for NMR data.
47+
- [MassBank EU](https://massbank.eu/)
48+
A field-specific ecosystem of databases and tools for mass spectrometry reference spectra.
49+
- [MetaboLights](https://www.ebi.ac.uk/metabolights/)
50+
A repository for metabolomic studies.
51+
- [nmrXiv](https://nmrxiv.org/)
52+
A repository for NMR data.
5353

5454
This list is not exhaustive, and there may be other repositories that are more suitable for your data.
5555

docs/10_domains/20_electrochemistry.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ title: "Electrochemistry"
33
slug: "/electrochemistry"
44
---
55

6-
import { LbeChip } from "@site/src/components/lbe/LbeElements.js";
6+
import LbeChip from "@site/src/components/commons/LbeChip.js";
7+
78
import ElnFinder from "@site/src/components/eln/ElnFinder.js";
89

910
<LbeChip title="physical chemistry" />

docs/10_domains/30_pharmaceutical_chemistry.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ title: "Medicinal / Pharmaceutical Chemistry"
33
slug: "/pharmaceutical_chemistry"
44
---
55

6-
import { LbeChip } from "@site/src/components/lbe/LbeElements.js";
6+
import LbeChip from "@site/src/components/commons/LbeChip.js";
7+
78
import ElnFinderPharm from "@site/src/components/eln/ElnFinderPharm.js";
89

910
<LbeChip title="medicinal chemistry" />

docs/10_domains/40_physical_chemistry.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ title: "Physical and Computational Chemistry"
33
slug: "/physical_chemistry"
44
---
55

6-
import { LbeChip } from "@site/src/components/lbe/LbeElements.js";
6+
import LbeChip from "@site/src/components/commons/LbeChip.js";
7+
78
import ElnFinder from "@site/src/components/eln/ElnFinder.js";
89

910
<LbeChip title="physical chemistry" />

docs/10_domains/60_synthetic_chemistry.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ nfdi4chem-id: dsoic
44
slug: "/synthetic_chemistry"
55
---
66

7-
import { LbeChip } from "@site/src/components/lbe/LbeElements.js";
7+
import LbeChip from "@site/src/components/commons/LbeChip.js";
8+
89
import ElnFinder from "@site/src/components/eln/ElnFinder.js";
910

1011
<LbeChip title="inorganic chemistry" />

0 commit comments

Comments
 (0)