Skip to content

Commit 7b5774e

Browse files
committed
mention codecheck-py in multiple spots on the website
1 parent 1532eb9 commit 7b5774e

File tree

4 files changed

+23
-12
lines changed

4 files changed

+23
-12
lines changed

guide/bundle.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,17 @@ This may include a copy of the author's files, and any additional files that the
2424
- Dockerfile and Docker image, see [Ten simple rules for writing Dockerfiles for reproducible data science](https://doi.org/10.1371/journal.pcbi.1008316)
2525
- ...
2626

27-
## Codecheck certificate with R Markdown
27+
## Codecheck certificate with computational notebooks
2828

29-
R Markdown has some nice features that are helpful for writing a report.
29+
Computational notebooks such as R Markdown (Rmd), Jupyter, or Quarto have very nice features that are helpful for writing a CODECHECK certificate.
3030

3131
- Literate programming and code chunks (hidden, visible) with nice looking and mostly hastle free PDF output (using [tinytex](https://yihui.name/tinytex/))
3232
- You can configure document metadata, e.g. the title or subtitle, anywhere in the document, so you can choose to configure them only in the `codecheck.yml`, see [this example](https://github.com/codecheckers/Piccolo-2020/blob/master/codecheck/piccolo2020-codecheck.Rmd)
33-
- The CODECHECK [assistant](https://github.com/codecheckers/assistant/) is an R package that streamlines report writing with R
34-
- You can capture the metadata of the computing environment in an automatically generated _colophon_ that lists installed packages and session information (using `sessionInfo()` or `devtools::session_info()`), see for example [this one](https://github.com/benmarwick/rrtools/blob/master/inst/templates/paper.qmd) in the template from `rrtools` by Ben Marwick, or a _reproducibility receipt_, see [this code example](https://github.com/PredictiveEcology/pemisc/blob/cf1516ff3893a7ffbfe1ae6623c0350c47c3e1b2/R/reproducibilityReceipt.R), which adds git repository information and information about external libraries to the session information
33+
- You can capture the metadata of the computing environment in an automatically generated _colophon_ that lists installed packages and session information (using `sessionInfo()` or `devtools::session_info()` in R), see for example [this one](https://github.com/benmarwick/rrtools/blob/master/inst/templates/paper.qmd) in the template from `rrtools` by Ben Marwick, or a _reproducibility receipt_, see [this code example](https://github.com/PredictiveEcology/pemisc/blob/cf1516ff3893a7ffbfe1ae6623c0350c47c3e1b2/R/reproducibilityReceipt.R), which adds git repository information and information about external libraries to the session information
34+
35+
We provide templates for R Markdown and Jupyter notebooks in an R package and a Python project:
36+
37+
- [R package `codecheck`](https://codecheck.org.uk/codecheck/) with Rmd templates and functions to validate metadata and upload the certificate to Zenodo
38+
- [Python project `codecheck-py`](https://github.com/codecheckers/codecheck-py/) with a Jupyter notebook template and functions to validate
39+
40+
In the future, a CODECHECK [assistant](https://github.com/codecheckers/assistant/) could be helpful - share your ideas an wishes in the project repository.

guide/community-workflow-codechecker.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Now it's your turn.
1717
1. Create a project in an online repository, either by forking existing code repository or creating new project
1818
1. [In case you forked] Create a directory `codecheck` where your files will go
1919
1. Create a new document to write the CODECHECK certificate and _start documenting the ongoing codecheck now with everything relevant that you do_;
20-
the exact form of a codechecking procedure and form of documentation vary greatly, but there are some tools, such as [an R package](https://github.com/codecheckers/codecheck) to automate some steps, including [an Rmd template](https://github.com/codecheckers/codecheck/blob/master/inst/extdata/templates/codecheck/) and word processor templates in [.odt](/guide/templates/CODECHECK_report_template.odt) and [.docx](/guide/templates/CODECHECK_report_template.docx) formats; all of that is optional, as long as the final certificate contains the mandatory information
20+
the exact form of a codechecking procedure and form of documentation vary greatly, but there are some tools, such as [an R package including an Rmd template](https://github.com/codecheckers/codecheck) and [a Python project including a Jupyter Notebook template](https://github.com/codecheckers/codecheck-py) to automate some steps; you may also use the word processor templates in [.odt](/guide/templates/CODECHECK_report_template.odt) and [.docx](/guide/templates/CODECHECK_report_template.docx) formats; all of that is optional, as long as the final certificate contains the mandatory information
2121
1. Open the manuscript and follow the instructions to reproduce the workflow
2222
1. During the CODECHECK, contact the authors in case of problems; keep in mind the general [CODECHECK principles](/project/#the-codecheck-principles), especially "the codechecker records but does not fix" – unless it is trivial change; the authors can provide updated versions of code and documentation; however, the entire procedure should not be much more time-intensive than a normal peer review of a paper and not involve more than a few code revisions; the codechecker can always stop the process after a reasonable effort and document on the issue as not successfully reproduced.
2323
1. Summarize the process and outcomes in your certificate and upload it as PDF to your project; add edited files and intemediary as well as output files as you see fit; the certifiate must at least contain the information on who checked what and how; the ambition should be to document for future self and other researchers; have a look at the available certificates.
@@ -69,11 +69,15 @@ Some further tips:
6969
- Make the repository [Binder-ready](https://mybinder.readthedocs.io/); put all Binder-related files into `.binder/` directory to separate them from the author's content.
7070
1. **Write the CODECHECK certificate** and save it as a PDF file named **`codecheck.pdf`** in the check directory.
7171
The certificate should cover at least _WHO_ (you, but maybe with support from others?) checked _WHAT_, and _HOW_.
72-
There are not strict requirements on the form, but you're welcome to use our word processor templates in [.odt](/guide/templates/CODECHECK_report_template.odt) and [.docx](/guide/templates/CODECHECK_report_template.docx) formats or the [.Rmd template from our R package](https://github.com/codecheckers/codecheck/blob/master/inst/extdata/templates/codecheck/).
73-
Imagine the certificate as a reminder for future you so you will be to re-check the workflow in two years time - what help would you need to do that?
74-
There is no need to document every detailed step if that is not helpful for you.
72+
There are not strict requirements on the form, but you're welcome to use one of our **templates**:
73+
- Word processor templates in [.odt](/guide/templates/CODECHECK_report_template.odt) and [.docx](/guide/templates/CODECHECK_report_template.docx) formats,
74+
- [.Rmd template from our R package](https://github.com/codecheckers/codecheck/blob/master/inst/extdata/templates/codecheck/) including some automation for validation and uploading, and
75+
- [a Python project including a Jupyter Notebook template](https://github.com/codecheckers/codecheck-py) including some automation for validation and uploading.
76+
Imagine the certificate as a _reminder for future you_ so you will be to re-check the workflow in two years time - what help would you need to do that?
77+
There is no need to document every step in detail if it is trivial to you today, but do put down the things that required you to think/tinker/research.
78+
This level of detail makes it likely enough that others can follow your steps, and ensures that you could provide more details if need be in the future.
7579
Include a _full citation of the certificate_, because your CODECHECK is a valuable contribution to science (see below for reserving the DOI).
76-
Take a look at the [example CODECHECKs](/guide/community-workflow-overview#examples) for existing certificates to serve as templates.
80+
Take a look at the [example CODECHECKs](/guide/community-workflow-overview#examples) for existing certificates to serve as context.
7781
1. [Optional] **Add more certificate sections** depending on interest, time, and skills:
7882
- Do the generated outputs match the ones in the original manuscript? Are the differences relevant or not?
7983
- Are there any parts of the workflow where the author could improve the code?

guide/event-recipe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -288,8 +288,8 @@ Hope to have encouraged you to go for it -- Success!
288288
5. The workshop **codecheckers** create a new directory in their
289289
working environment where all new files go, and start documenting
290290
the ongoing CODECHECK; exact form of codechecking procedure can vary
291-
greatly; there are some optional tools, such as an R package that
292-
includes an Rmd template for the report and automates some steps,
291+
greatly; there are some optional tools, such as an R package or a Python project that
292+
include an Rmd respectively a Jupyter notebook template for the report and automates some steps,
293293
and templates for word processors to use
294294

295295
6. During a CODECHECK, the workshop **codecheckers** can ask the

nl/workflow.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ You are probably doing fine even if you digress from this documentation!
1616
1. **Authors** send their request for a CODECHECK to project e-mail address <[email protected]>.
1717
1. The **CHECK-NL project team** accepts the request for the workshop or advises to follow the normal community workflow (see above).
1818
1. During the workshop, **codecheckers** download materials or clone the a repository and work on their computers.
19-
1. The **codecheckers** create a new directory in their working environment where all new files go, and start documenting the ongoing codecheck; the exact form of codechecking procedure and form of documentation vary greatly, but there are some tools, such as an [R package](https://github.com/codecheckers/codecheck) to automate some steps, including an [Rmd template](https://github.com/codecheckers/codecheck/tree/master/inst/extdata/templates/codecheck); all of that is optional, as long as the final report contains the mandatory information; the templates in [.odt](/guide/templates/CODECHECK_report_template.odt) and [.docx](/guide/templates/CODECHECK_report_template.docx) formats should get you going quickly.
19+
1. The **codecheckers** create a new directory in their working environment where all new files go, and start documenting the ongoing codecheck; the exact form of codechecking procedure and form of documentation vary greatly, but there are some tools, such as an echeck) and [a Python project including a Jupyter Notebook template](https://github.com/codecheckers/codecheck-py) to automate some steps; all of that is optional, as long as the final report contains the mandatory information; the templates in [.odt](/guide/templates/CODECHECK_report_template.odt) and [.docx](/guide/templates/CODECHECK_report_template.docx) formats should get you going quickly if you prefer a plain word processor for writing the certificate.
20+
1. Open the manuscript and follow the instructions to reproduce the workflow.
2021
1. During codecheck, the **codecheckers** can ask the **authors** (if present at the workshop) in case of encountered problems, keeping in mind the [CODECHECK principles](/project#the-codecheck-principles) (especially "the codechecker records but does not fix" – unless it is a very trivial bug like pathnames).
2122
1. The **codecheckers** summarize the process and outcome in a report - the CODECHECK certificate - and bundle it with all input and output files; this workshop codecheck bundle is then shared with the **CHECK-NL project team** via email or repository; the report should at least contain the information on who checked what and how; document for future self and other researchers; have a look at the available reports; most contain also optional information (compare [CODECHECK community workflow guide](/guide/community-workflow-overview)).
2223
1. The **CHECK-NL project team** checks the bundle and report, and together with the workshop codecheckers, revise where necessary; once ready, either the **CHECK-NL project team** or the **codechecker** upload the file on Zenodo or OSF, and [optionally] adds a pull request to original repository for the CODECHECK badge.

0 commit comments

Comments
 (0)