Skip to content

Commit

Permalink
Provide additional references
Browse files Browse the repository at this point in the history
  • Loading branch information
fkohrt committed Nov 26, 2024
1 parent bae9be8 commit ab8857b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
15 changes: 11 additions & 4 deletions literature.bib
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ @online{Wheeler2014

@online{Matt2009,
title = {Why {CC} {BY}-{SA} is Unsuitable},
url = {https://osmfoundation.org/wiki/Licence_and_Legal_FAQ/Why_CC_BY-SA_is_Unsuitable},
url = {https://osmfoundation.org/w/index.php?title=Licence_and_Legal_FAQ/Why_CC_BY-SA_is_Unsuitable&oldid=3927},
titleaddon = {{OpenStreetMap} Foundation},
author = {{Matt}},
urldate = {2024-09-02},
Expand Down Expand Up @@ -225,7 +225,7 @@ @misc{Klimpel2013

@online{ODI2015,
title = {What are the impacts of non-open licences?},
url = {https://theodi.org/insights/guides/what-are-the-impacts-of-non-open-licences/?saved},
url = {https://theodi.org/insights/guides/what-are-the-impacts-of-non-open-licences/},
abstract = {This guide outlines the key considerations that inform licensing decisions},
author = {{Open Data Institute}},
urldate = {2024-09-03},
Expand Down Expand Up @@ -399,7 +399,7 @@ @collection{Kreutzer2014

@online{CC2015,
title = {{ShareAlike} compatibility analysis: {GPL}},
url = {https://wiki.creativecommons.org/wiki/ShareAlike_compatibility_analysis:_GPL},
url = {https://wiki.creativecommons.org/index.php?title=ShareAlike_compatibility_analysis:_GPL&oldid=114476},
author = {{Creative Commons}},
urldate = {2024-09-03},
date = {2015-08-08}
Expand Down Expand Up @@ -526,7 +526,7 @@ @online{Stallman2022NoLimit

@online{Moller2023,
title = {The case for Free use: reasons not to use a Creative Commons -{NC} license},
url = {https://freedomdefined.org/Licenses/NC},
url = {https://freedomdefined.org/index.php?title=Licenses/NC&oldid=27327},
author = {Möller, Erik},
urldate = {2024-09-21},
date = {2023-12-15},
Expand All @@ -541,4 +541,11 @@ @online{Fogel2006
urldate = {2024-09-21},
date = {2006-05-27},
langid = {american},
}
@online{UKGovernment2020,
title = {Quality assurance of code for analysis and research},
url = {https://best-practice-and-impact.github.io/qa-of-code-guidance/},
urldate = {2024-11-26},
author = {{UK Government Analytical Community}},
year = {2020},
}
3 changes: 2 additions & 1 deletion setup.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ vals <- list(
)
```

Generally, metadata are either stored embedded into the data or externally, for example, in a separate file. We will use the "[frictionless data](https://frictionlessdata.io/)" standard, where metadata are stored separately.
Generally, metadata are either stored embedded into the data or externally, for example, in a separate file. We will use the "[frictionless data](https://frictionlessdata.io/)" standard, where metadata are stored separately. Another alternative would be [RO-Crate](https://www.researchobject.org/ro-crate/).

Specifically, one can use the R package [`frictionless`](https://docs.ropensci.org/frictionless/) to create a _schema_ which describes the structure of the data. For the purpose of the following code, it is just a nested list that we edit to include our own information. We also explicitly record in the schema that missing values are stored in the data file as `NA` and that the data are licensed under [CC0\ 1.0](https://creativecommons.org/publicdomain/zero/1.0/). Finally, the package is used to create a metadata file that contains the schema.

Expand Down Expand Up @@ -421,6 +421,7 @@ This is only a brief summary and there is much more to be learned about coding p

- "Tidy design principles" [@Wickham2023Design]
- "The Good Research Code Handbook" [@Mineault2021]
- "Quality assurance of code for analysis and research" [@UKGovernment2020]
- "The Art of UNIX Programming" [@Raymond2003]

> "Any fool can write code that a computer can understand. Good programmers write code that humans can understand."
Expand Down

0 comments on commit ab8857b

Please sign in to comment.