Skip to content

Commit

Permalink
Style changes
Browse files Browse the repository at this point in the history
  • Loading branch information
larsvilhuber authored Jan 17, 2024
1 parent 952be89 commit 41b015b
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 18 deletions.
41 changes: 23 additions & 18 deletions part1a.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -38,23 +38,28 @@ Part 1:

# Reproducible practices

## Version your code and your results
## Version code and results

- Use versioning
- If available, use `git`
- If not available, request `git`
- If not, use regular backups (scripted, automated)
While we are assessing reproducibility of others, our work must be reproducible as well.

- Use versioning. We will use `git`. We will show you how.
- Keep a log of your work
- Git will log some things
- You will keep a high-level log (notes) of your work in the report (`REPLICATION.md`)
- Commit often (at least once a day)

# Part 1 | Ideal structure

## Generic project setup
## What do we tell researchers?

Here's a few generic guidelines for researchers. You will be on the lookout for these things!

![TIER protocol](images/tier-protocol.png)
## Generic project setup

![TIER protocol](images/tier-protocol.png)
[TIER Protocol](https://www.projecttier.org/tier-protocol/specifications-3-0/)

## Basic project setup
## Basic project setup {#user}

::: {.columns-2}

Expand Down Expand Up @@ -83,7 +88,7 @@ Part 1:

:::

## Project setup examples
## Project setup examples {#user}


::: {.columns-2}
Expand Down Expand Up @@ -118,20 +123,20 @@ It doesn't really matter, as long as it is logical. We will get to how this tran

# Computational Empathy

## Consider how the next person will (be able to) compute
## Consider how the next person will (be able to) compute {#user}

- You don't know who that is
- You dont know what they dont know
- You don't know what they don't know
- Will not have any of your add-on packages/ libraries/ etc. pre-installed
- Dont force them to do tedious things
- Don't force them to do tedious things

**It might be "Future You!"**

## It *IS* you
## It *IS* you {#user}

The replicator is the first (?) reader of the instructions who will need to reproduce the analysis.

## Streamlining
## Streamlining {#user}

- Master script preferred
- Least amount of manual effort
Expand All @@ -142,7 +147,7 @@ The replicator is the first (?) reader of the instructions who will need to repr
- No manual install of packages
- Use a script to create all directories, install all necessary packages/requirements/etc.

## Reproducibility
## Reproducibility {#user}

- No manual manipulation
- “Change the parameter to 0.2, then run the code again”
Expand All @@ -153,7 +158,7 @@ The replicator is the first (?) reader of the instructions who will need to repr
- No manual calculation of numbers
- Use cross-platform programming practices

## Cross-platform programming practices 1
## Cross-platform programming practices 1 {#user}

**Use programming-language specific code as much as possible**

Expand All @@ -167,7 +172,7 @@ shell unzip "C:\data\myfile.zip"
```


## Cross-platform programming practices 1
## Cross-platform programming practices 1 {#user}

Most languages have appropriate code:

Expand All @@ -186,7 +191,7 @@ unzipfile "zipfile.zip" [, replace]
```


## Cross-platform programming practices 2
## Cross-platform programming practices 2 {#user}

Use neutral pathnames (mostly forward slashes)

Expand Down
5 changes: 5 additions & 0 deletions style.css
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,9 @@ background-color:#c0cbf87d;
.warning {
background-color: #f5b3b8;
}

#author {
background-color: rgba(0, 0, 255, 0.24);
}

/* end of customizations */

0 comments on commit 41b015b

Please sign in to comment.