tdjames1 / FAIR4RS_repos_dois

Carpentries lesson for FAIR4RS component, software repos, DOIs, metadata, citation at TUoS

Leaving the below instructions for now but this will be replaced with proper README text in time.

Lesson Title: Software repos, DOIs, metadata, citation

Lesson Description: While putting your software online certainly helps it satisfy the FAIR principles, simply doing so might not be enough for other researchers to actually find and utilise what you’ve put out there.

It’s important to know the benefits and issues with where you store and publish your data, and to make the most of the tools these platforms provide, such as Digital Object Identifiers (DOIs). It’s also important to know best practice for how to increase the visibility and citability of your work in cases where your chosen platform lacks these features.

This course will introduce and explore worked examples of elements that you should consider when publishing your software, which will help you easily reference your work, and also help make it more findable and reusable by others.

Rendered version of the lesson: ??

Contact Information: Please contact [e-mail] for any queries regarding this lesson

Contributing Information: ??

Credits/acknowledgements: [to be completed]

Citation: 'https://github.com/RicCampbell/FAIR4RS_repos_dois/blob/main/CITATION.cff'

Licence: 'https://github.com/RicCampbell/FAIR4RS_repos_dois/blob/main/LICENSE.md'

The Carpentries Workbench Template R Markdown Lesson

This lesson is a template lesson that uses The Carpentries Workbench.

Note about lesson life cycle stage

Although the config.yaml states the life cycle stage as pre-alpha, the template is stable and ready to use. The life cycle stage is preset to "pre-alpha" as this setting is appropriate for new lessons initialised using the template.

Create a new repository from this template

To use this template to start a new lesson repository, make sure you're logged into Github.
Visit https://github.com/carpentries/workbench-template-rmd/generate and follow the instructions. Checking the 'Include all branches' option will save some time waiting for the first website build when your new repository is initialised.

If you have any questions, contact @tobyhodges

Configure a new lesson

Follow the steps below to complete the initial configuration of a new lesson repository built from this template:

1. Make sure GitHub Pages is activated: navigate to Settings, select Pages from the left sidebar, and make sure that gh-pages is selected as the branch to build from. If no gh-pages branch is available, check Actions to see if the first website build workflows are still running. The branch should become available when those have completed.
2. Adjust the config.yaml file: this file contains global parameters for your lesson site. Individual fields within the file are documented with comments (beginning with #) At minimum, you should adjust all the fields marked 'FIXME':
   • title
   • created
   • keywords
   • life_cycle (the default, pre-alpha, is the appropriate for brand new lessons)
   • contact
3. Annotate the repository with site URL and topic tags: navigate back to the repository landing page and click on the gear wheel/cog icon (similar to ⚙️) at the top-right of the About box. Check the "Use your GitHub Pages website" option, and add some keywords and other annotations to describe your lesson in the Topics field. At minimum, these should include:
   • lesson
   • the life cycle of the lesson (e.g. pre-alpha)
   • the human language the lesson is written in (e.g. deutsch)
4. Adjust the name of the .Rproj file. It is simplest to make this match the name of the repository.
5. Adjust the CODE_OF_CONDUCT.md, CONTRIBUTING.md, and LICENSE.md files as appropriate for your project.
   • CODE_OF_CONDUCT.md: if you are using this template for a project outside The Carpentries, you should adjust this file to describe who should be contacted with Code of Conduct reports, and how those reports will be handled.
   • CONTRIBUTING.md: depending on the current state and maturity of your project, the contents of the template Contributing Guide may not be appropriate. You should adjust the file to help guide contributors on how best to get involved and make an impact on your lesson.
   • LICENSE.md: in line with the terms of the CC-BY license, you should ensure that the copyright information provided in the license file is accurate for your project.
6. Update this README with relevant information about your lesson and delete this section.