Skip to content

Commit

Permalink
Merge pull request #211 from Brilator/suggestions
Browse files Browse the repository at this point in the history
Suggestions
  • Loading branch information
Freymaurer authored Oct 16, 2024
2 parents 0ac9b0a + b2e6ca8 commit 7bb4f50
Show file tree
Hide file tree
Showing 16 changed files with 20 additions and 63 deletions.
4 changes: 2 additions & 2 deletions src/content/articles/arc-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Contribute to ARC development
description: You want to contribute to our Annotated Research Context (ARC) concept or tools? Find out more.
---
The [**A**nnotated **R**esearch **C**ontext (ARC)](https://nfdi4plants.github.io/arc-website/) is DataPLANT's central concept for organizing and documenting research data, focal point of collaboration, data exchange, and overall FAIR Digital Object of choice.
The [**A**nnotated **R**esearch **C**ontext (ARC)](https://arc-rdm.org) is DataPLANT's central concept for organizing and documenting research data, focal point of collaboration, data exchange, and overall FAIR Digital Object of choice.

When using the DataPLANT tools (e.g. [ARCitect](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/ARCitect-Manual/index.html]) and [guides](https://nfdi4plants.org/nfdi4plants.knowledgebase/index.html) to create ARCs, the majority of ARC guidelines will be followed automatically.

Expand All @@ -11,5 +11,5 @@ However, the **ARC is not a top-down mandated concept**, but rather a community-
The ARC specification is a living document that is continuously improved and extended upon.
It is [hosted on GitHub](https://github.com/nfdi4plants/ARC-specification) and open for contributions from the community, as well as [general discussions](https://github.com/nfdi4plants/ARC-specification/discussions).

The same is true for all ARC-related tooling developed by DataPLANT: development is done out in the open on our [GitHub organization](https://github.com/nfdi4plants), which also has an [top-level discussion forum](https://github.com/orgs/nfdi4plants/discussions).
The same is true for all ARC-related tooling developed by DataPLANT: development is done out in the open on our [GitHub organization](https://github.com/nfdi4plants), which also has a [top-level discussion forum](https://github.com/orgs/nfdi4plants/discussions).
For the core ARC tools, we even have an [open development board](https://github.com/orgs/nfdi4plants/projects/10/views/2), which gives an overview on the entire development process of our core developer team.
2 changes: 1 addition & 1 deletion src/content/articles/arc-general.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ It is important to mention, since it is is often misunderstood, that the ‘A’

The [ARC (**A**nnotated **R**esearch **C**ontext)](https://arc-rdm.org) is an implementation of the FDO concept.
It is a framework for organizing and documenting research data, as well as a container that continuously supports collaboration, data exchange, and adherence to FAIR principles among various researchers.
It is developed under the umbrella of DataPLANT for for plant research, but is applicable to many other research domains.
While being developed under the umbrella of DataPLANT for plant research, the ARC is applicable to many other research domains.

DataPLANT develops and maintains [tools for the ARC ecosystem](/resources/#toolbox), hosts [services to collaborate on ARCs](https://nfdi4plants.github.io/arc-data-hub/), and provides [training and support](https://nfdi4plants.github.io/support/) for ARC users.
10 changes: 5 additions & 5 deletions src/content/articles/arc-how-to-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ title: Start your own ARC
description: You want to make your scientific data FAIR (Findable, Accessible, Interoperable, and Reusable)? Start now with our Annotated Research Context (ARC).
---

The ARC is the central framework for research data management in DataPLANT.
ARCs are fair digital objects, that follow the RO Crate and ISA standard and package all research data and metadata related to your investigation.
The ARC is the central framework for research data management (RDM) in DataPLANT.
ARCs are fair digital objects (FDOs), that follow the RO Crate and ISA standard and package all research data and metadata related to your investigation.
Their folder structure comprises studies, assays, workflows and runs, as well as subfolders for protocols and raw data.
By default, ARCs also contain metadata files that follow the ISA standard.
To facilitate and partly automate the creation of ARCs two tools were developed: The ARCCommander is a command line-based tool for ARC creation, whereas ARCitect employs a graphical user interface for ARC creation and also integrates the annotation tool Swate.
To facilitate and partly automate the creation of ARCs two tools were developed: The ARC Commander is a command line-based tool for ARC creation, whereas ARCitect employs a graphical user interface for ARC creation and also integrates the annotation tool Swate.

ARCCommander and ARCitect also allow you to track all commits and push your ARC to the PLANTdataHUB for versioning, storage and sharing with collaborators or the whole scientific community.
ARC Commander and ARCitect also allow you to track all commits and push your ARC to the PLANTdataHUB for versioning, storage and sharing with collaborators or the whole scientific community.

To read more about ARCs, check out our [ARC website](arc-rdm.org).

If you want to start creating your ARC, you can find detailed guides for the [ARCCommander](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/ArcCommanderManual/index.html) and [ARCitect](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/ARCitect-Manual/index.html) in the knowledgebase.
If you want to start creating your ARC, you can find detailed guides for the [ARC Commander](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/ArcCommanderManual/index.html) and [ARCitect](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/ARCitect-Manual/index.html) in the knowledge base.
2 changes: 1 addition & 1 deletion src/content/articles/become-a-member.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ All tools can be downloaded on [GitHub](https://github.com/nfdi4plants) or are a
To use all functionalities related to your FAIR digital research object, the Annotated Research Context (ARC), creating a free DataPLANT account will be useful.
This will allow you to upload and continuously synchronize your ARC with the PLANTdataHUB, share it with collaborators and access or contribute to ARCs of collaborators that are not public.

To create a DataPLANT account you can follow [this link](https://auth.nfdi4plants.org/realms/dataplant/protocol/openid-connect/auth?client_id=account&redirect_uri=https%3A%2F%2Fauth.nfdi4plants.org%2Frealms%2Fdataplant%2Faccount%2Flogin-redirect&state=0%2F2083ce25-95bf-4a38-ba82-0502f7060042&response_type=code&scope=openid).
To create a DataPLANT account you can follow [this link](https://register.nfdi4plants.org).
2 changes: 1 addition & 1 deletion src/content/articles/collect-and-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Our tools ARCitect and ARCCommander simplify the creation, structur
The ARCitect and ARCCommander are two essential tools developed by DataPLANT that assist users with the creation and management of ARCs.
ARCitect employs a graphical user interface to guide researchers in creating, organizing, and annotating research data, ensuring adherence to FAIR principles.
ARCCommander complements ARCitect by offering robust management capabilities via the command line.
By initializing a new ARC using ARCitect or ARCCommander, the ARC folder structure, including studies, assays, workflows and runs as well as subfolders is contructed.
By initializing a new ARC using ARCitect or ARCCommander, the ARC folder structure, including studies, assays, workflows and runs as well as subfolders is constructed.
ISA metadata files are automatically added to each study and assay and can be easily filled using the same tools.
The tools provide structured assistance and automation with processes following the ARC specification.
ARCitect and ARCCommander initialize your ARC as a git repository, allowing you to track changes of your ARC.
Expand Down
2 changes: 1 addition & 1 deletion src/content/articles/custom-training.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ description: You want to learn how you can use the Annotated Research Context to

In addition to offering educational material on DataPLANT’s concepts and tools online, DataPLANT’s Data Stewards offer custom support for your RDM.

If you are interested in arranging a 1-2 day custom training with our Data Stewards you can reach out to us via our email address <a href="mailto:[email protected]">[email protected]</a>.
If you are interested in arranging a 1-2 day custom training with our Data Stewards you can reach out to us via <a href="javascript:location='mailto:\u0069\u006e\u0066\u006f\u0040\u006e\u0066\u0064\u0069\u0034\u0070\u006c\u0061\u006e\u0074\u0073\u002e\u006f\u0072\u0067';void 0"><script type="text/javascript">document.write('\u0069\u006e\u0066\u006f\u0040\u006e\u0066\u0064\u0069\u0034\u0070\u006c\u0061\u006e\u0074\u0073\u002e\u006f\u0072\u0067')</script>email</a>.
2 changes: 1 addition & 1 deletion src/content/articles/discover-and-explore-arcsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ The ARCSearch is a tool for integrated search and analysis of individual ARCs an
The web-based user interface provides a consolidated real-time view of the public ARCs within the DataPLANT community as well as of a user's private ARCs after log-in.
The search functions of the ARC Registry application enable users to explore the ARCs and their assay data based on keywords and metadata.
The users can look up the ARCs by specific keywords, such as the working group they are interested in, the ARC creator or by the title of the ARC.
Most importantly, the users can also search and explore the experimental metadata from various ARCs simultaneously, thus, paving the way toward crossomics metadata exploration within the community.
Most importantly, the users can also search and explore the experimental metadata from various ARCs simultaneously, thus, paving the way toward cross-omics metadata exploration within the community.

[Try ARCSearch](https://arcregistry.nfdi4plants.org/isasearch)
2 changes: 1 addition & 1 deletion src/content/articles/fundamentals-rdm.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ description: Learn more about research data management and why it is important (

Whether you are new to RDM or simply want to increase your knowledge and skills, we have compiled several articles on the fundamentals of RDM, including the FAIR principles, metadata and ontologies, data sharing and publications and more.

You can find these articles in our [knowledgebase](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/fundamentals/index.html).
You can find these articles in our [Knowledge Base](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/fundamentals/index.html).
43 changes: 0 additions & 43 deletions src/content/articles/knowledge-base.md

This file was deleted.

4 changes: 2 additions & 2 deletions src/content/articles/manuals.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Browse our guides to learn more about DataPLANTs tools and services
---

DataPLANT offers several tools to facilitate RDM.
To help you make the most of these tools we offer detailed, step by step guides and examples in our knowledgebase.
Here you can find guides for creating and managing ARCs with the ARCCommander, ARCitect or ARCmanager, creating metadata annotation tables with Swate and sharing your data on the DataHUB.
To help you make the most of these tools we offer detailed, step by step guides and examples in our knowledge base.
Here you can find guides for creating and managing ARCs with the ARC Commander, ARCitect or ARCmanager, creating metadata annotation tables with Swate and sharing your data on the DataHUB.

Explore our [knowledge base](https://nfdi4plants.org/nfdi4plants.knowledgebase/index.html) to find manuals for tools but also guides for e.g. contributing to ontologies and applying metadata standards.
2 changes: 1 addition & 1 deletion src/content/articles/planning-dataplan.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Data management plans (DMPs) describe the handling of research data throughout i
To streamline the creation of DMPs for plant scientists, DataPLANT developed the DMP Generator DataPLAN as a web-based tool.
Tailored to the needs of researchers in plant science, DataPLAN provides a user-friendly interface that guides scientists through the process of creating comprehensive, FAIR-compliant DMPs.
It provides templates fitting the DMP requirements of different funders, like DFG, Horizon Europe, or BMBF, making it easier for researchers to meet compliance obligations.
In addition to presenting the respective questions to be answered, DataPLAN also comprises prewritten text blocks as answers.
In addition to presenting the respective questions to be answered, DataPLAN also comprises pre-written text blocks as answers.
These answers in part depend on the selections, e.g. of data types to be generated, made by the users. Any required free text information is asked for in the form of simple questions and automatically integrated into the text at the necessary positions.


Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion src/content/subpage/participation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
- participation/arc-how-to-start
- participation/github
- participation/broker-ontology
- participation/template-repo
- participation/swate-templates
- participation/arc-development
image: /src/assets/images/subpage/participation/participation-mainpage.svg
styling:
Expand Down
2 changes: 1 addition & 1 deletion src/content/subpageContent/about/rdm-concept.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ summary: "DataPLANT’s Research Data Management (RDM) concept focusses on FAIR
---

DataPLANT’s research data management (RDM) concept focusses on FAIR compliance, data and service interoperability, community participation, knowledge transfer, and long-term sustainability.
It is tailored to the plant community and aims to establish sustainable RDM processes and habits. DatapPLANT sees RDM as a collaborative and continuous process.
It is tailored to the plant community and aims to establish sustainable RDM processes and habits. DataPLANT sees RDM as a collaborative and continuous process.
The goal is to transform static research artifacts into dynamic, growing research objects that are continuously extended, annotated, processed, analyzed, and managed alongside ongoing research activities, ensuring that research artifacts are produced in a FAIR manner.
The core technology for DataPLANT’s strategy is the ARC.
ARCs provide a set of guidelines for combining data, metadata, and workflows in a file system layout that is easy to understand and ensures that changes to data, metadata, or workflows are well-defined and consistent.
Expand Down
2 changes: 1 addition & 1 deletion src/content/subpageContent/participation/github.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Contribute to our GitHub repositories
summary: DataPLANT's work is openly accesible on GitHub. Contributions to our repositories are welcome.
summary: DataPLANT's work is openly accessible on GitHub. Contributions to our repositories are welcome.
icon: tabler:brand-github
href: "/articles/github"
---
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
title: Contribute to our templates
summary: Our annotation tool Swate simplifies adding standardized metadata for your experimental workflows. You would like to contribute a template?
icon: tabler:table-share
href: "/articles/template-repo"
href: "/articles/swate-templates"
---

0 comments on commit 7bb4f50

Please sign in to comment.