Skip to content
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

Localisation #415

Merged
merged 114 commits into from
Nov 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
114 commits
Select commit Hold shift + click to select a range
a3b63bb
add: new structure template (comment)
nap84 Jan 23, 2024
9000de4
add: outlined new article in meetng
nap84 Jan 23, 2024
e222b81
add: link to methods table in gdrive
nap84 Jan 23, 2024
80d1a33
add: first draft of introduction
nap84 Jan 26, 2024
5080436
add: (attempt) first draft on data types
nap84 Jan 26, 2024
3795ad3
add: first draft elns and other tools
nap84 Jan 26, 2024
245928b
add: first draft publishing data, challenges
nap84 Jan 26, 2024
0d4150f
refactor: article structure
jliermann Apr 3, 2024
fbcf834
feat: text draft
jliermann Apr 3, 2024
bc444bb
Merge remote-tracking branch 'upstream/main' into analytical_chemistry
jliermann Apr 19, 2024
a6d8a50
chore: update packages
jliermann Apr 19, 2024
5ec7620
feat: getEln script for ELN Finder
jliermann Apr 19, 2024
b9878f2
feat: show ELNs from ELN Finder
jliermann Apr 19, 2024
70240b3
chore: target dir for eln script
jliermann Apr 22, 2024
bab437c
fix: chmod +x
jliermann Apr 22, 2024
f38dae7
fix: filename
jliermann Apr 22, 2024
8d8075e
fix: better target dir
jliermann Apr 22, 2024
19d9bd8
chore: make Open source bold
jliermann Apr 22, 2024
b30cd07
chore: remove unnec. console output
jliermann Apr 22, 2024
b9adfcd
updated titles to fit other articles
nap84 May 6, 2024
94f9c00
updated data types and tools sections
nap84 May 6, 2024
75eabce
small updates to tools
nap84 May 6, 2024
e32c5cf
removed notes and old content comments
nap84 May 6, 2024
2d07bfa
Merge pull request #351 from jliermann/analytical_chemistry
jliermann May 6, 2024
6a1e181
Merge remote-tracking branch 'origin/main' into domains_rework
jliermann Jul 2, 2024
92c5588
Merge remote-tracking branch 'origin/main' into domains_rework
jliermann Jul 9, 2024
f9c8565
test: eln-finder staging
jliermann Jul 9, 2024
b2bfb6d
test: eln-finder staging
jliermann Jul 9, 2024
fadab26
feat: display ELNs as cards
jliermann Jul 9, 2024
ce10fb2
feat: abstraction of ElnFinder component
jliermann Jul 9, 2024
e84a44a
chore: remove unnec. code
jliermann Jul 10, 2024
821571c
chore: remove unnec. code
jliermann Jul 10, 2024
447289e
refactor: reorganize chips
jliermann Jul 10, 2024
d00b1e3
feat: text search component
jliermann Jul 10, 2024
aabd5bc
refactor: reorganize chips
jliermann Jul 10, 2024
f6e449e
feat: first draft for filtering
jliermann Jul 10, 2024
f276007
feat: handling of button filtering
jliermann Jul 10, 2024
8be570c
feat: improve behaviour and styling
jliermann Jul 10, 2024
5c5a8c8
feat: allow filtering through props
jliermann Jul 10, 2024
992864e
feat: eln-finder demo with props
jliermann Jul 10, 2024
4f616c3
chore: misc styling improvements
jliermann Jul 11, 2024
99966d9
chore: shorter desc.
jliermann Jul 11, 2024
85525e6
chore: extend inherited class
jliermann Jul 11, 2024
b37af83
chore: improve styling
jliermann Jul 11, 2024
39b31b2
refactor: allow filtering from cards, remove chip components
jliermann Jul 11, 2024
506c390
feat: reset button for input field
jliermann Jul 11, 2024
213ea2f
refactor: shorten code
jliermann Jul 11, 2024
baa1775
Update 50_pharmaceutical_chemistry.mdx
BenjaminGolub Jul 16, 2024
14f765a
Merge branch 'domains_rework' into domain-PC-update
jliermann Jul 16, 2024
fb50091
Merge branch 'domain-PC-update' of https://github.com/NFDI4Chem/knowl…
jliermann Jul 16, 2024
be39c09
chore: added link to Git
jliermann Jul 16, 2024
e225cb9
chore: add ELN-finder
jliermann Jul 16, 2024
8c5f5b7
Merge pull request #374 from NFDI4Chem/domain-PC-update
jliermann Jul 16, 2024
d4be167
fix: eln-finder import
jliermann Jul 16, 2024
b4ad787
Merge remote-tracking branch 'origin/main' into domains_rework
jliermann Jul 16, 2024
b7a0cac
Update 50_pharmaceutical_chemistry.mdx
BenjaminGolub Jul 17, 2024
e74002e
Update 50_pharmaceutical_chemistry.mdx
BenjaminGolub Jul 17, 2024
a611ad3
Update 50_pharmaceutical_chemistry.mdx
BenjaminGolub Jul 17, 2024
31d6f45
Update 50_pharmaceutical_chemistry.mdx
Ted-Bender Jul 17, 2024
d3ebaf8
Update 50_pharmaceutical_chemistry.mdx
Ted-Bender Jul 17, 2024
bb4fcb7
Merge pull request #373 from BenjaminGolub/main
jliermann Jul 17, 2024
b4a4461
Merge branch '373-Update-50_pharmaceutical_chemistry.mdx' into patch-3
jliermann Jul 17, 2024
90c133f
Merge pull request #377 from Ted-Bender/patch-3
jliermann Jul 17, 2024
adc323d
Merge pull request #379 from NFDI4Chem/373-Update-50_pharmaceutical_c…
jliermann Jul 17, 2024
002a03f
Merge remote-tracking branch 'origin/main' into domains_rework
jliermann Jul 17, 2024
2b072e6
Merge remote-tracking branch 'origin/main' into domains_rework
jliermann Jul 25, 2024
6689dce
feat: ShortenDesc component
jliermann Aug 20, 2024
0f05328
chore: consolidate ShortenDesc component
jliermann Aug 20, 2024
e5e3746
fix: correct elnFinder subdisc
jliermann Aug 20, 2024
34a251b
Merge remote-tracking branch 'origin/main' into domains_rework
jliermann Aug 20, 2024
de6ba22
Merge remote-tracking branch 'upstream/domains_rework' into domains_r…
jliermann Sep 8, 2024
84e4e11
feat: pharmacy eln component
jliermann Sep 8, 2024
fd1e6ae
refactor: adapt to work without subdisciplines
jliermann Sep 8, 2024
71f0d76
feat: get pharmacy data
jliermann Sep 8, 2024
17b077d
fix: lf / add testing path
jliermann Sep 8, 2024
2b48212
feat: add pharmacy ELNs component
jliermann Sep 8, 2024
e9b978b
fix: catch if no subdisciplines exist
jliermann Sep 8, 2024
1fc616e
chore: do not track data file
jliermann Sep 8, 2024
b4f15bc
Merge pull request #396 from jliermann/domains_rework
jliermann Sep 8, 2024
9d7bc6d
feat: new synthetic chem text
jliermann Oct 2, 2024
3478405
chore: save table from prettier
jliermann Oct 7, 2024
018ac67
Merge remote-tracking branch 'origin/main' into domains_rework
jliermann Oct 7, 2024
b0aba43
chore: harmonise headings
jliermann Oct 7, 2024
b139823
fix: mdx comment syntax
jliermann Oct 7, 2024
a645213
chore: harmonise headings
jliermann Oct 7, 2024
0088a22
chore: remove polymer chem
jliermann Oct 7, 2024
b061f62
chore: do not use summary for now
jliermann Oct 7, 2024
e1fd7c6
fix: heading depth
jliermann Oct 7, 2024
4142627
chore: add link to contributing page
jliermann Oct 30, 2024
402cd55
fix: remove faq links
jliermann Oct 30, 2024
d9859c2
Merge pull request #403 from jliermann/main
jliermann Oct 30, 2024
3e911ac
Merge pull request #404 from NFDI4Chem/domains_rework
jliermann Oct 30, 2024
bf9d550
fix typo, add comment
nap84 Oct 31, 2024
e6e7a25
add more comment
nap84 Oct 31, 2024
b9ef569
add: emphasis on linking data via Crossref metadata; check: Crossref …
nap84 Oct 31, 2024
2214efe
fix: grammar
nap84 Oct 31, 2024
26fad74
add: note on third-party data ownership
nap84 Oct 31, 2024
8b6a0c6
fix comment on linking
nap84 Oct 31, 2024
9f3f937
fix: generic sentence, improve text
nap84 Oct 31, 2024
e2a0ac1
fix: grammar
nap84 Oct 31, 2024
12cb7f3
add links
nap84 Oct 31, 2024
3933e12
Update docs/50_data_publication/70_publishing_standards/10_publishing…
jliermann Nov 4, 2024
cf0cbb3
MDX style comments if absolutely necessary
jliermann Nov 4, 2024
b2db5b6
Merge pull request #408 from NFDI4Chem/402-update-data-publishing-art…
jliermann Nov 4, 2024
4146d39
Update 10_dmp.mdx
Ted-Bender Nov 5, 2024
7b6423c
Update 15_choose_eln.mdx
Ted-Bender Nov 11, 2024
ac26dbd
Merge pull request #409 from Ted-Bender/patch-4
jliermann Nov 11, 2024
8472e75
Merge pull request #412 from Ted-Bender/patch-5
jliermann Nov 11, 2024
718ec96
fix: broken link
jliermann Nov 11, 2024
de18a23
fix: broken link
jliermann Nov 11, 2024
17b6e75
fix: broken links
jliermann Nov 11, 2024
9dbd7af
Merge pull request #413 from jliermann/main
jliermann Nov 11, 2024
ba15ce0
fix: remove button for polymer chem.
jliermann Nov 11, 2024
7778a65
Merge pull request #414 from jliermann/main
jliermann Nov 11, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
fonts
# Localisation files
/i18n
# API data
elnData.json
elnDataPharm.json
# Generated files
.docusaurus
.cache-loader
Expand Down
2 changes: 1 addition & 1 deletion docs/00_intro/10_fair.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Especially when looking at metadata, effective and efficient machine readability

### I2. (meta)data use vocabularies that follow FAIR principles

The applied vocabularies or ontologies should be well-documented and resolvable using a PID. For instance, CHMO mentioned [above](#i1-metadata-use-a-formal-accessible-shared-and-broadly-applicable-language-for-knowledge-representation) uses a [persistent URL (PURL)](http://www.purlz.org/home), resolvable using a standard web browser through `http`, while the [documentation](https://github.com/rsc-ontologies/rsc-cmo) is publicly available on Github.
The applied vocabularies or ontologies should be well-documented and resolvable using a PID. For instance, CHMO mentioned [above](#i1-metadata-use-a-formal-accessible-shared-and-broadly-applicable-language-for-knowledge-representation) uses a [persistent URL (PURL)](https://en.wikipedia.org/wiki/Persistent_uniform_resource_locator), resolvable using a standard web browser through `http`, while the [documentation](https://github.com/rsc-ontologies/rsc-cmo) is publicly available on Github.

### I3. (meta)data include qualified references to other (meta)data

Expand Down
89 changes: 28 additions & 61 deletions docs/10_domains/10_analytical_chemistry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,84 +4,51 @@ nfdi4chem-id: dac
slug: "/analytical_chemistry"
---

import Methods from '@site/src/components/Methods.js';
import {LbeChip} from '@site/src/components/lbe/LbeElements.js';
import { LbeChip } from "@site/src/components/lbe/LbeElements.js";
import ElnFinder from "@site/src/components/eln/ElnFinder.js";

<LbeChip title="analytical chemistry" /><LbeChip title="chemometric" />
<LbeChip title="analytical chemistry" />
<LbeChip title="chemometric" />

## Introduction

:::info Summary:
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.

Analytical chemistry is one of the oldest scientific disciplines and an interdisciplinary science, combining methods of physical, inorganic and organic chemistry. Analytical chemistry aims to acquire, process, and evaluate signals to qualify and quantify the composition and to unravel the structure of matter. The analytical chemist applies classical (wet) chemistry and instrumental methods for separation, identification (qualification) and quantification. The discipline is related to many research fields in life, environmental, earth, and engineering sciences, such as metabolomics, medicine, and geochemistry. <br/>
A typical workflow begins with the conceptualisation of the research question, and the planning of experiments, methods, and surveys to evaluate the hypotheses. Surveys are utilised in life, environmental, and earth sciences to perform experiments and/or to obtain samples required to support the research (e.g., laboratory and field campaigns, cohort studies). Experiments are conducted and samples are processed applying existing or newly established methods along with recording of accompanying metadata. Analytical chemistry applies already in the experimental or sampling stage as conditions need to be controlled or metadata has to be acquired (e.g., pH, temperature, colour). Once the product of the experiment or sample processing is obtained, it is analysed with suitable direct or combined methods for identification and quantification. Processing and interpretation of the acquired research data and [metadata](/docs/metadata) support the answering of the research question and decisions for further experiments, research, and measures.
:::
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.

## Type of experiments for chemical analysis
## Data Types

### Sampling
Unlike some other areas of chemistry, most research data in analytical chemistry are generated by instrumental methods. In addition, the size and complexity of the data can vary greatly depending on the method used.

- Collecting of materials for analysis
- Transport and storage without alteration of samples
- Small-scale experiments to develop / optimise approaches and equipment
- Upscaling of methods to obtain sufficient material for a comprehensive analysis
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.

### Sample processing
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.

- Preparation of the sample for analysis:
- Direct methods: no further treatment (e.g., pH, RFA, MALDI, direct infusion)
- Single methods:
- Dissolving
- Extraction
- Pulverising
- Combined methods:
- Extraction and enrichment (e.g., solid-phase extraction, aqua regia digestion, volatilisation of solvents)
- Separation of interfering compounds (e.g., chromatography, precipitation)
- Chemical transforming in measurable form (e.g., complexing, derivatisation)
- Small-scale experiments for screening / optimization of separation conditions and upscaling
## ELNs and Other Tools

### Determination and evaluation
- Product characterisation with feasible methods (e.g., NMR spectroscopy, mass spectrometry, IR spectroscopy, UV/vis spectroscopy, elemental analysis)
- to identify analytes (targeted and non-targeted)
- to assess the constitution of mixtures
- to quantify analytes
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.

## Planning of experiments
<ElnFinder subDisc="Analytical chemistry" />

- New and reused analytical methods and research ideas are derived from previous work of the own research group, scientific literature, datasets published in [repositories](/docs/repositories), and requirements of public calls for research, development and demonstration projects.
- Experimental design follows a logical order to achieve a specific goal, such as analytical selectivity and sensitivity, or in the case of a non-targeted analysis (e.g., in metabolomics), a coverage of a broad physical-chemical domain of analytes.
- Planning is concluded by adding the experimental details. All [metadata](/docs/metadata) is [documented](/docs/data_documentation) in an [ELN](/docs/eln) (e.g., [Chemotion ELN](https://www.chemotion.net/chemotionsaurus/index.html)) including references.
## Publishing Data

## Documentation of experiments
Data from analytical chemistry can be published on several platforms, depending on the research subject and data type.

- Documentation of research data and metadata is carried out digitally using an ELN.
- Experimental conditions (e.g., solvents, temperature, duration, pressure) are noted in the ELN and if available a laboratory information system.
- Observations and results of analytical methods with no digital output (i.e. no data files) are added manually to the ELN entry of the experiment, which may include temperatures, or the pH (with metadata where applicable).
- Obtained data from analytical instruments (e.g., NMR, MS, or IR data) are uploaded to the Chemotion ELN in open file formats and directly attached to the respective ELN experiment entry including instrumental setup metadata.
- In case instrumental metadata is not convertible to open format without information loss, conditions need to be documented in the ELN.
- Metadata related to the obtained data, such as mass, volumes, or solvent of measurement, have to be provided according to [metadata standards](/docs/format_standards).
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.

## Data producing methods
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.

- Data can be collected during the experiment or after the experiment by analysing the obtained product.
- Manually determined data: Experimental observations, mass, volumes, pH, etc.
- Digital data are obtained with analytical instruments. An overview of file extensions, file sizes, and converters for several analytical methods is given in the table below.
- Raw data files in proprietary file formats should be saved alongside interoperable open file formats by using converters or the analytical device software. If no specific open format is currently available, export as .txt or .csv is recommended. Please be aware that metadata included in the header of .txt or .csv files may not follow a defined (open) format and metadata should be additionally also added into the ELN.
For method-specific data, several specialised repositories are available. A few examples include:

<Methods defaultProfile={"synthetic"} />
- [MassBank EU](https://massbank.eu/)
A field-specific ecosystem of databases and tools for mass spectrometry reference spectra.
- [MetaboLights](https://www.ebi.ac.uk/metabolights/)
A repository for metabolomic studies.
- [nmrXiv](https://nmrxiv.org/)
A repository for NMR data.

:::note *This table will be continuously updated with new recommendations on interoperable open file formats.
:::
This list is not exhaustive, and there may be other repositories that are more suitable for your data.

## Data analysis
## Challenges

- Research data can be processed, analysed and compared (also to data of other experiments) within the [Chemotion ELN](https://www.chemotion.net/chemotionsaurus/index.html).
- Optionally, preprocessing of digital data with software of analytical device before data are transferred to the Chemotion ELN (cf. data producing methods).
- A detailed view, evaluation and interpretation of results is carried out with the Chemotion ELN features.


## Publishing research data

- In addition to a research article in a scientific journal, the underlying research data are [published](/docs/data_publishing) in a [repository](/docs/repositories) and linked to the article to realise research data management according to the [FAIR data principles](/docs/fair) ([Best practice examples](/docs/best_practice)).
- Data publications in repositories include raw and processed data for reuse.
- The use of the [Chemotion ELN](https://www.chemotion.net/chemotionsaurus/index.html) enables a direct transfer of research data and the respective metadata to the [Chemotion Repository](https://www.chemotion-repository.net/welcome). Subsequently, these data are automatically shared with other repositories, e.g. [PubChem](https://pubchem.ncbi.nlm.nih.gov/). For the publication of research data in other discipline-specific repositories, such as the [MassBank](https://massbank.eu/MassBank/) for reference mass spectra, data have to be exported from the Chemotion ELN and submitted to the respective database.
- A [persistent identifier](/docs/pid) (e.g., DOI) is generated for a dataset by a repository (e.g., [DataCite](https://datacite.org/) for the Chemotion Repository), which is given in the journal article or corresponding supporting information to link the data publication with the manuscript.
The biggest challenge in managing analytical chemistry data is the diversity of the field. Different methods generate different types of data, and the data can vary greatly in size and complexity. As mentioned above, the large number of different vendors and proprietary data formats is a major barrier to data sharing and reuse.
Loading
Loading