Skip to content

Commit dc21f21

Browse files
committed
Update README.md
1 parent 40188fe commit dc21f21

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# moorea_filmies
22

3-
Code repostitory to run analyses and generate figures and manuscript for Nitta et al. "Intergenerational Niche Differentiation in Filmy Ferns (Hymenophyllaceae)".
3+
Code repostitory to run analyses and generate figures and manuscript for Nitta et al. "Ecophysiological differentiation between life stages in filmy ferns (Hymenophyllaceae)". ([preprint](https://doi.org/10.1101/2021.03.12.435213))
44

5-
All code is in [R](https://cran.r-project.org/). The [targets package](https://wlandau.github.io/targets/index.html) is used to manage the workflow.
5+
All code is in [R](https://cran.r-project.org/). The [targets package](https://wlandau.github.io/targets/index.html) is used to manage the workflow.
66

77
To run all analyses and generate the manuscript:
88

@@ -20,8 +20,8 @@ For each of the links below, click on "Download Dataset" or "Download all", then
2020

2121
## Reproducible analysis with Docker
2222

23-
The analysis code requires various packages to be installed, and may not work properly if package versions have changed. Therefore, a
24-
[Docker image is provided](https://hub.docker.com/r/joelnitta/moorea_filmies) to run the code reproducibly. You can
23+
The analysis code requires various packages to be installed, and may not work properly if package versions have changed. Therefore, a
24+
[Docker image is provided](https://hub.docker.com/r/joelnitta/moorea_filmies) to run the code reproducibly. You can
2525
[install docker from here](https://docs.docker.com/install/).
2626

2727
Navigate to the cloned repository (where `/path/to/repo` is the path on your machine):
@@ -33,13 +33,13 @@ cd /path/to/repo
3333
Unzip the data:
3434

3535
```
36-
docker run --rm -v ${PWD}:/tmpdir -w /tmpdir joelnitta/moorea_filmies:0.0.1 Rscript R/unzip_data.R
36+
docker run --rm -v ${PWD}:/tmpdir -w /tmpdir joelnitta/moorea_filmies:0.0.2 Rscript R/unzip_data.R
3737
```
3838

3939
Run `targets::tar_make()`:
4040

4141
```
42-
docker run --rm -v ${PWD}:/tmpdir -w /tmpdir joelnitta/moorea_filmies:0.0.1 Rscript -e 'targets::tar_make()'
42+
docker run --rm -v ${PWD}:/tmpdir -w /tmpdir joelnitta/moorea_filmies:0.0.2 Rscript -e 'targets::tar_make()'
4343
```
4444

4545
You will see the targets being built by `targets`. The final manuscript should be compiled at the end as `manuscript.docx` (MS for journal submission) and `moorea_filmies_preprint.pdf` (preprint PDF) in the `results/ms` folder. Other figure and table files will also be compiled. Supplemental information will be written to the `results/si` folder.
@@ -52,7 +52,7 @@ If you want to interact with the code in the Docker container, you can launch th
5252
docker-compose up -d
5353
```
5454

55-
Navigate to http://localhost:8787/ in your browser of choice (firefox or google chrome recommended). There, you should be able to access an instance of the [RStudio](https://rstudio.com/) IDE, which can be used to inspect and manipulate objects in R.
55+
Navigate to http://localhost:8787/ in your browser of choice (firefox or google chrome recommended). There, you should be able to access an instance of the [RStudio](https://rstudio.com/) IDE, which can be used to inspect and manipulate objects in R. You can click on "Build All" in the "Build" tab to run the workflow.
5656

5757
When you're done, take down the container:
5858

0 commit comments

Comments
 (0)