Skip to content

Commit

Permalink
Minor edits (#23)
Browse files Browse the repository at this point in the history
   * minor edits to traits.build book that have been on a branch for a while:
        - Add details about cloning template repository
   * updated actions-cache step to v4

closes #18

closes #8

closes #22

---------

Co-authored-by: Fonti Kar <[email protected]>
  • Loading branch information
ehwenk and fontikar authored Dec 17, 2024
1 parent 3086f5a commit 62d9fea
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/render.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
needs: check

- name: Cache results
uses: actions/cache@v2
uses: actions/cache@v4
with:
path: |
_book
Expand Down
4 changes: 3 additions & 1 deletion tutorial_compilation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This tutorial walks you through an example of creating a `traits.build` database

## Clone traits.build-template

traits.build-template is a GitHub repository that contains:
[traits.build-template](https://github.com/traitecoevo/traits.build-template) is a GitHub repository that contains:

1. Core files required to build your own database:
- a sample [trait dictionary](https://github.com/traitecoevo/traits.build-template/blob/master/config/traits.yml)
Expand All @@ -29,6 +29,8 @@ traits.build-template is a GitHub repository that contains:

- As of September 2023 there are 3 tutorials, but this will expand to 6 tutorials by October 2023.

To clone the repository, either visit the GitHub repository and click on the green `<> Code` tab toward the upper right corner of the [landing page](https://github.com/traitecoevo/traits.build-template), or clone the repository through GitHub desktop, R Studio, or your choice of Git client.

## Build the example

Once you have cloned the repository and installed the package, the next step is to build the simplistic sample database:
Expand Down
8 changes: 7 additions & 1 deletion tutorial_dataset_4.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ source("R/custom_R_code.R")

1. Use `metadata_add...` functions where possible.\
2. Mutate new columns using `custom_R_code`.\
3. Manually map newly creted column names in the appropriate part of the `metadata.yml` file.\
3. Manually map newly created column names in the appropriate part of the `metadata.yml` file.\

#### **Create a metadata template**

Expand Down Expand Up @@ -196,6 +196,12 @@ Notes:\

------------------------------------------------------------------------

#### **Fill in missing dataset-level metadata**

- Manually fill in the the information for the fields `description`, `basis_of_record`, `life_stage` and `sampling_strategy`, copying information from the supplied text file into `metadata.yml`.

------------------------------------------------------------------------

#### **Add traits** {#map_metadata_from_columns}

There is a single trait for this study, Huber value, which is the sapwood area to leaf area ratio. However, in the data.csv file it is documented as `log_LA.SA` and another line of custom R code must be added:\
Expand Down
2 changes: 2 additions & 0 deletions tutorial_datasets.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ remotes::install_github("traitecoevo/traits.build")
```
2. Cloned the traitecoevo/traits.build-template repository.

- Click on the green `<> Code` tab toward the upper right corner of `https://github.com/traitecoevo/traits.build-template`.

3. Built the [example database](tutorial_compilation.html).

The tutorial is divided into the following sections:
Expand Down

0 comments on commit 62d9fea

Please sign in to comment.