From 40e2d2f5d728de1d699e5917555ce72a18e0a507 Mon Sep 17 00:00:00 2001 From: Maike Kleemeyer Date: Wed, 11 Sep 2024 11:34:05 +0200 Subject: [PATCH] unify use of "life cylce" and FAIR writing style --- data-organisation.qmd | 2 +- documentation.qmd | 2 +- publication.qmd | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/data-organisation.qmd b/data-organisation.qmd index 83e4736..71000e3 100644 --- a/data-organisation.qmd +++ b/data-organisation.qmd @@ -8,7 +8,7 @@ link-external-newwindow: true Research data is valuable for researchers and forms the basis for their research. Therefore, it is advisable to structure the data well to save time and effort in the daily handling of research data. In this part of the workshop, we will look closer at organizational aspects of data management, mainly the folder structure, file and folder naming, and file formats. -A clear and consistent folder structure and folder and file naming convention are important for making your data [**f**indable and **i**nteroperable](https://www.go-fair.org/fair-principles/). You should think about it beforehand in order to avoid inconsistencies or the need to rename large amounts of data. +A clear and consistent folder structure and folder and file naming convention are important for making your data [**f**indable](https://www.go-fair.org/fair-principles/) and [**i**nteroperable](https://www.go-fair.org/fair-principles/). You should think about it beforehand in order to avoid inconsistencies or the need to rename large amounts of data. Your structure and your naming conventions should be intuitive. However, we recommend to explicitly describe them (typically in a [README file](documentation.qmd#readme-file)) because they may not be that intuitive for others or your future self ("why did I do it like this?"). diff --git a/documentation.qmd b/documentation.qmd index ac8831b..88f6efe 100644 --- a/documentation.qmd +++ b/documentation.qmd @@ -5,7 +5,7 @@ link-external-newwindow: true ## Overview -Effective documentation is a crucial aspect of [FAIR](https://www.go-fair.org/fair-principles/) data management, ensuring that research data are not only well-organized but also easily **F**indable, **A**ccessible, and **R**eusable by others. In this section, we'll delve into the importance of documentation by exploring how to create best practice documentation that supports the entire research lifecycle. We'll cover the essential components like including metadata that provide context and description of the dataset, as well as README files that offer a concise introduction to the dataset. Additionally, we'll discuss the role of codebooks for making all components of the dataset self-explanatory. +Effective documentation is a crucial aspect of [FAIR](https://www.go-fair.org/fair-principles/) data management, ensuring that research data are not only well-organized but also easily **f**indable, **a**ccessible, and **r**eusable by others. In this section, we'll delve into the importance of documentation by exploring how to create best practice documentation that supports the entire research data life cycle. We'll cover the essential components like including metadata that provide context and description of the dataset, as well as README files that offer a concise introduction to the dataset. Additionally, we'll discuss the role of codebooks for making all components of the dataset self-explanatory. ## Metadata diff --git a/publication.qmd b/publication.qmd index 254c127..d3a074f 100644 --- a/publication.qmd +++ b/publication.qmd @@ -5,7 +5,7 @@ link-external-newwindow: true ## Overview -Data publication is the final step of [FAIR data management](https://www.go-fair.org/fair-principles/), ensuring data **F**indability and **A**ccessibility (when done well). If you have taken care of the previous sections [Data organization](data-organisation.qmd) and [Documentation](documentation.qmd) and thereby made your data **I**nteroperable and **R**eusable, publishing those data will take minimal effort. +Data publication is the final step of [FAIR data management](https://www.go-fair.org/fair-principles/), ensuring data **f**indability and **a**ccessibility (when done well). If you have taken care of the previous sections [Data organization](data-organisation.qmd) and [Documentation](documentation.qmd) and thereby made your data **i**nteroperable and **r**eusable, publishing those data will take minimal effort. Most commonly, data are published as supplements to journal articles and an increasing number of journals actually require that. Datasets can also be published in specialized data journals (e.g., Scientific data, Data in Brief), which means that the article itself is a rich and detailed description of the dataset. As you may have guessed, this option is mainly chosen for rather large, sampling-intensive datasets. Last but not least, it is also possible to publish an independent (without connected publication) dataset in a repository and this is often required by funders like the DFG or EU. Irrespective of the publication option, there are common good practices when publishing data, namely - indicating in the article that data and/or code are available,