You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This will allow manual to be visible on pkgdown website.
Also allows developers to update and version control the manual
Eventually we want 3 levels of documentation:
Highest level overview of planning framework describing the need and application of WTW
WTW manual with a non-technical intro (targeted at planners)
Data prep instructions for different workflows (targeted at GIS staff)
Ongoing list of additions:
Consider adding more user friendly intro to the manual. Possibly with a simple example of the tool in action. The intro should also clearly summarise the input data requirements to avoid confusion with new users who try to upload their own non-prepped data and expect the tool to prep it for them.
Link to the wtw-data-prep repo in the sections that discuss input data.
More detail on the formatting requirement for shapefile input option. This could also be added to wtw-data-prep
Binary vs continuous variable. An explanation of when you might want to convert a continuous variable to a binary. e.g. habitat probability maps, climate refugia maps: in these cases you could run WTW using the continuous maps but the tool could end up meeting the target by gathering up a bunch of low value cells. Deciding a cutoff for high quality habitat or climate refugia and converting the input data to binary maps allows a more explicit analysis.
The text was updated successfully, but these errors were encountered:
I think this should be added as a pkgdwon article and not a vignette by using usethis::use_artice() instead of usethis::use_vignette(). The reason is we don't really need the manual to be a vignette since users are rarely installing the wtw package. Keeping the .Rmd out of the package makes R CMD check easier and development is simpler.
Ongoing list of additions:
The text was updated successfully, but these errors were encountered: