Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://psychoinformatics-de.github.io/rdm-course/
Research Data Management with DataLad
https://psychoinformatics-de.github.io/rdm-course/
Last synced: 27 days ago
JSON representation
Research Data Management with DataLad
- Host: GitHub
- URL: https://psychoinformatics-de.github.io/rdm-course/
- Owner: psychoinformatics-de
- License: other
- Created: 2021-09-14T08:52:25.000Z (about 3 years ago)
- Default Branch: gh-pages
- Last Pushed: 2024-09-23T12:10:01.000Z (3 months ago)
- Last Synced: 2024-10-11T05:02:26.179Z (2 months ago)
- Language: HTML
- Homepage: https://psychoinformatics-de.github.io/rdm-course/
- Size: 13.6 MB
- Stars: 9
- Watchers: 7
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION
- Authors: AUTHORS
Awesome Lists containing this project
- awesome-RDM - Research Data Management with DataLad - de/rdm-course)] (General resources / Courses)
README
RDM with DataLad
================
This workshop teaches best practices for Research Data Management with DataLad.
Content for this workshop was developed by the DataLad team,
while the workshop infrastructure is based on materials developed by The Carpentries (distributed under a CC-BY license).
Contributors
============
For extensive information on how the Carpentries Lesson styles template
is set up and how to customize it, see: https://carpentries.github.io/lesson-example/index.html.
## Editing the config
The `_config.yml` file in the repo root allows several options for customization.
The `carpentry` variable is set to `swc` (line 10), meaning that for any updates where
we want DataLad-specific content to display we will have to ensure these are edited wherever `swc`-specific logic occurs.
## Editing the main page
Edit the `index.md` file in the repo root.
## Adding "episodes"
Add a Markdown file per new episode in the `_episodes` directory.
The `_episodes/01-formatting.md` file can be used as a template for new
episodes, as it already contains examples of most formatting options /
components that will likely be needed.
Prepend sequential numerical values to the filename in order to specify
episode order.
Episodes will automatically appear in order as part of the schedule on
the main page.
## Setup for local rendering of lessons
To preview the changes locally, follow the instructions from
[Carpentries lesson example](https://carpentries.github.io/lesson-example/setup.html).
Short version:
```bash
# Install:
sudo apt-get install ruby ruby-dev build-essential libxml2-dev
gem install bundler --user-install
# Add ~/.local/share/gem/ruby/2.7.0/bin to path, as per printed message
# In the root of the repository (once) to install dependencies
bundle update
# Start the server
make serve
```
## Slides
The slides are placed in `files/slides-org-reveal`.
Html files (based on the [reveal.js](https://revealjs.com/) framework) can be viewed directly in the web browser.
Slide content was written in [org mode](https://orgmode.org/) (org files are also included)
and converted using [org-reveal](https://github.com/yjwen/org-reveal) to produce html output.
Credit
======
This repo's design was adapted from
[The Carpentries lesson styles template](https://github.com/carpentries/styles/)
(licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).)
The RDM training material itself was created by the DataLad team,
either in full, or adapted from existing openly available material.
Sources include:
- [DataLad Handbook](https://handbook.datalad.org)
- [Naming Things](http://www2.stat.duke.edu/~rcs46/lectures_2015/01-markdown-git/slides/naming-slides/naming-slides.pdf)" (CC0) by Jenny Bryan
- [Project structure](https://slides.djnavarro.net/project-structure) by Danielle Navarro
- [The Turing Way](https://the-turing-way.netlify.app/) (CC-BY 4.0)
Acknowledgements
================
These training materials were developed with funding from the Deutsche
Forschungsgemeinschaft (DFG, German Research Foundation) under grant SFB 1451
([431549029](https://gepris.dfg.de/gepris/projekt/431549029), INF project).