-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated installation instructions and readme
- Loading branch information
1 parent
3885c69
commit 964a62f
Showing
3 changed files
with
71 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,58 +1,64 @@ | ||
| # BirdFlowR | ||
|
|
||
| <!-- badges: start --> | ||
| [](https://github.com/birdflow-science/BirdFlowR/actions/workflows/R-CMD-check.yaml) | ||
| [](https://app.codecov.io/gh/birdflow-science/BirdFlowR?branch=main) | ||
| <!-- badges: end --> | ||
|
|
||
| An R package to forecast changes in distributions and generate synthetic migration routes based on BirdFlow models. | ||
|
|
||
| This package is under development and not yet formally released. Function names and arguments may change. | ||
|
|
||
| ## Installation | ||
|
|
||
| Install the package and the accompanying data package from github: | ||
| ```{r} | ||
| devtools::install_github("birdflow-science/BirdFlowModels") # data package | ||
| devtools::install_github("birdflow-science/BirdFlowR", build_vignettes = TRUE) | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| The two primary functions are `forecast()` to project distributions and | ||
| `route()` to generate synthetic routes. | ||
|
|
||
| `route_migration()` is a wrapper to `route()` which automates sampling | ||
| locations from the a distribution for the start of the migration and setting | ||
| the start and end dates to route for the migration window. We can use it to | ||
| create synthetic routes for a species. | ||
| ```{r} | ||
| library(BirdFlowR) | ||
| library(BirdFlowModels) | ||
| library(terra) | ||
| bf <- amewoo | ||
| species(bf) | ||
| # start migration at end of the nonbreeding season | ||
| start <- species_info(bf, "nonbreeding_end") | ||
| # Retreive starting distribution as a SpatRaster and plot | ||
| r <- rast(bf, start) | ||
| plot(r) | ||
| # Generate migration routes | ||
| rts <- route_migration(bf, 10, "prebreeding") | ||
| # Add lines to plot | ||
| plot(rts$lines, add = TRUE, col = rgb(0, 0, 0, .25)) | ||
| ``` | ||
|
|
||
| ## Learn more | ||
|
|
||
| Read `vignette("BirdFlowR")` for a longer introduction to the package. | ||
|
|
||
|
|
||
| # BirdFlowR | ||
|
|
||
| <!-- badges: start --> | ||
| [](https://github.com/birdflow-science/BirdFlowR/actions/workflows/R-CMD-check.yaml) | ||
| [](https://app.codecov.io/gh/birdflow-science/BirdFlowR?branch=main) | ||
| <!-- badges: end --> | ||
|
|
||
| An R package to forecast changes in distributions and generate synthetic migration routes based on BirdFlow models. | ||
|
|
||
| This package is under development and not yet formally released. Function names and arguments may change. | ||
|
|
||
| ## Installation | ||
|
|
||
| Install just the package: | ||
| ```{r} | ||
| devtools::install_github("birdflow-science/BirdFlowR") | ||
| ``` | ||
| Or to install with example data and vignette: | ||
|
|
||
| ```{r} | ||
| install.packages("remotes") | ||
| install.packages("rnaturalearthdata") # required for vignette | ||
| remotes::install_github("birdflow-science/BirdFlowModels") # data package | ||
| remotes::install_github("birdflow-science/BirdFlowR", build_vignettes = TRUE) | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| The two primary functions are `forecast()` to project distributions and | ||
| `route()` to generate synthetic routes. | ||
|
|
||
| `route_migration()` is a wrapper to `route()` which automates sampling | ||
| locations from the a distribution for the start of the migration and setting | ||
| the start and end dates to route for the migration window. We can use it to | ||
| create synthetic routes for a species. | ||
| ```{r} | ||
| library(BirdFlowR) | ||
| library(BirdFlowModels) | ||
| library(terra) | ||
| bf <- amewoo | ||
| species(bf) | ||
| # start migration at end of the nonbreeding season | ||
| start <- species_info(bf, "nonbreeding_end") | ||
| # Retreive starting distribution as a SpatRaster and plot | ||
| r <- rast(bf, start) | ||
| plot(r) | ||
| # Generate migration routes | ||
| rts <- route_migration(bf, 10, "prebreeding") | ||
| # Add lines to plot | ||
| plot(rts$lines, add = TRUE, col = rgb(0, 0, 0, .25)) | ||
| ``` | ||
|
|
||
| ## Learn more | ||
|
|
||
| Read `vignette("BirdFlowR")` for a longer introduction to the package. | ||
|
|
||
|
|