Contributing Instructions - Graphical Modelling and Causal Inference
Authors/Creators
Description
There are currently two options to contribute to the Zenodo community Graphical Modelling and Causal Inference. For both options, a dataset (respectively dataset collection) or a notebook, a record on Zenodo has to be created and submitted to the community. The submissions are required to be topically related to the community. The community moderators process each submission, create the necessary embedding links, potentially request revisions, and assist with any questions. There are no associated costs.
1 Advantages of the Community
Central instruments of FAIR research are providing open data access to researchers and transparently communicating design decisions via metadata in a findable and well-structured place. The Zenodo platform hosted by CERN provides a long-term storage solution with unique digital object identifiers (DOIs), which can be referred to in publications. Uploading datasets and notebooks after publication is possible, and metadata (e.g., descriptions, licenses, references, etc.) can also be changed after the initial record creation. Other topical researchers have the advantage of freely accessing the portal, discovering and searching curated datasets, browsing through methodological notebooks to reproduce existing literature, and extend their own work.
2 Submitting on Zenodo
After logging into Zenodo via GitHub, ORCID, OpenAIRE, or a new account, you can create and submit a
-
dataset or dataset collection, or a
-
code base with a showcasing notebook
to the community. All submissions must align with the community’s scope. We provide instructions below, but we also require a certain format. After submission, the moderators are informed and will check the record. Please provide as much additional information as possible to the Zenodo object. Note that the created record and data cannot be deleted except under special circumstances. If uncertain, it is possible to test the mechanics of Zenodo without creating permanent digital objects in Zenodo’s Sandbox Instance.
For both notebooks and datasets, respectively dataset collections, we require a specific structure of the Zenodo record.
2.1 Datasets
--------------------------------------------------------------------------------------------------------------------------------------------------------------------
A description of the dataset/dataset collection.
# always two blank rows between information blocks
Task: A description of the Task.
Summary:
-
Size of dataset: Nr. of samples x Nr. of dimensions
-
Task: Causal Discovery Problem / Causal Inference Problem
-
Data Type: Continuous Data / Mixed Data / Discrete Data / Binary Data / Categorical Data
-
Dataset Scope: Collection of Datasets / Standalone Dataset
-
Ground Truth: Known Graph / Partial Graph / Unknown Graph
-
Temporal Structure: Static Data / Time Series Data
-
License: CC0 / CC BY / CC BY-NC / …
-
Missing Values: Existing Missing Values / No Missing Values
Missingness Statement: Missingness Statement, if applicable.
Collection: # If applicable.
-
Dataset1: Description Dataset1
-
Dataset2: Description Dataset2
-
…
Features:
-
Feature1: Description Feature1
-
Feature2: Description Feature2
-
…
Files:
-
File1: Description File1
-
File2: Description File2
-
…
License: # If applicable. Please indicate the main license (dataset, not of supporting material) above
-
File1: License1
-
File2: License2
--------------------------------------------------------------------------------------------------------------------------------------------------------------------
2.1 Notebooks
For notebooks, create a git repository with (1) the code, and (2) the notebook’s rendered .html file. Then, connected the repository with Zenodo as shown in the picture below.
[See picture 'zenodo_git_integration.png']
Source: https://zenodo.org/account/settings/github/
This will automatically create a record of the zipped repository along with a unique DOI. As the whole repository is zipped, we advise to restrict the repository’s content to the necessary files. The associated DOI will forward you to the Zenodo record, which you can submit it to the Graphical Modelling and Causal Inference community by editing the record’s page. Although the record’s description is taken from the git release, the records meta-information can be edited manually afterwards, e.g., referencing a publication, linking the associated Zenodo dataset or specifying an R package.
We showcase the rendered notebooks on this website’s gallery of Accompanying Statistical Notebooks. For this, please specify the path toward the .html in the submission text.
Please contact us when publishing a new release of the git repository. This will automatically trigger a new Zenodo version of the record. This website, however, will not be rendered automatically but manually by the MaRDI TA3 team. Note that the record on Zenodo, as a copy of the git, is permanent and previous record versions, respectively git releases, can still be accessed.
