Skip to content

Commit

Permalink
minor website changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Patricia Zauchner committed Sep 22, 2024
1 parent f57b340 commit d6cf711
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 10 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ To install the development version:

See the page
<a href="https://zauchnerp.github.io/gmoTree/articles/intro_to_gmoTree.html" target="_blank">Introduction
to gmoTree</a> for a more detailed overview of the functions.
to gmoTree</a> for a more detailed overview of most of the functions.
For further details on the package as a whole, visit the
<a href="https://zauchnerp.github.io/gmoTree/" target="_blank">
gmoTree website</a>.
Expand Down Expand Up @@ -100,4 +100,4 @@ frame.
# Before running the experiment

- `show_constant()`: Shows constant variables.
- `codebook()`: Creates a codebook based on the oTree code.
- `codebook()`: Creates a codebook based on the oTree code. See also the vignette <a href="https://zauchnerp.github.io/gmoTree/articles/codebook.html" target="_blank">"gmoTree Codebooks."</a>
5 changes: 3 additions & 2 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pkgdown_sha: ~
articles:
codebook: codebook.html
intro_to_gmoTree: intro_to_gmoTree.html
last_built: 2024-09-22T20:44Z
last_built: 2024-09-22T21:39Z
urls:
reference: https://zauchnerp.github.io/gmoTree/reference
article: https://zauchnerp.github.io/gmoTree/articles
2 changes: 1 addition & 1 deletion docs/search.json

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions vignettes/codebook.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ The output is structured with clear headings:
- Heading Level 1: Represents each app in the oTree data.
- Heading Level 2: `Group` and `Player` variables, categorized within each app. Showing the class `Constants` is optional and can be turned off by using the argument `include_cons = FALSE`.

<img src="c3.png" style = "border:1px solid" alt="Headings">
<img src="c3.PNG" style = "border:1px solid" alt="Headings">

Below is an example showing the structure for the `cournot` app, which includes all `Constants`, `Group`, and `Player` variables. If a class contains no information, the heading will still appear, along with the message "Empty class."

<img src="cournot.png" style = "border:1px solid" alt="App rankaversion Information">
<img src="cournot.PNG" style = "border:1px solid" alt="App rankaversion Information">

If the default codebook design does not meet your needs, you can create your own by selecting `output = "list"`. This will return all the information in list format, which you can then use in `R Markdown` to design your own custom codebook. Below is an example of a section of the list output for the `cournot` app.

Expand Down Expand Up @@ -130,7 +130,7 @@ str(cbook, 1)

By setting the `preamb = TRUE` parameter, a predefined description of oTree data is inserted at the beginning of the codebook, explaining how experimental data is stored by oTree.

<img src= "intro.png" style = "border:1px solid" alt="Introduction to oTree data picture">
<img src= "intro.PNG" style = "border:1px solid" alt="Introduction to oTree data picture">

# Customizing how the codebook is shown

Expand All @@ -148,7 +148,7 @@ codebook(
)
```

<img src="title.png" style = "border:1px solid" alt="Title picture">
<img src="title.PNG" style = "border:1px solid" alt="Title picture">

## Sorting the code

Expand Down

0 comments on commit d6cf711

Please sign in to comment.