Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert WTW manual to vignette #311

Closed
edwardsmarc opened this issue Apr 24, 2023 · 3 comments
Closed

Convert WTW manual to vignette #311

edwardsmarc opened this issue Apr 24, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@edwardsmarc
Copy link
Contributor

edwardsmarc commented Apr 24, 2023

  • 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.
@edwardsmarc edwardsmarc added the documentation Improvements or additions to documentation label Apr 24, 2023
@edwardsmarc edwardsmarc self-assigned this Apr 24, 2023
@edwardsmarc
Copy link
Contributor Author

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.

Same applies to #326

See https://r-pkgs.org/vignettes.html#sec-vignettes-article

@edwardsmarc
Copy link
Contributor Author

Screenshots need to be updated because some features have changed.

edwardsmarc added a commit that referenced this issue Jul 20, 2023
Add all authors to DESCRIPTION
@edwardsmarc
Copy link
Contributor Author

closed with #334

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant