naturecounts online documentation outline

[denislepage]

We should try to start drafting an outline for the instruction book for the package. Not sure it this issue is the best place to start this for now, or if we already have something in the works.

[steffilazerte]

How about I give you a preview of the 'default' site (and all the information it contains) first? That way you'll have a better sense of what needs to be added.

To serve the website, I'll need you to configure the repository. If you go to the Settings, scroll down to "GitHub Pages" and change the source to "master branch/docs folder". Then when I push the changes it'll populate a site at https://BirdStudiesCanada.github.io/naturecounts.

Official instructions here: https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages#publishing-your-github-pages-site-from-a-docs-folder-on-your-master-branch

[denislepage]

OK, done.

[steffilazerte]

Great, it's already up and running, so take a look and see what you think. There is a preliminary article/tutorial/vignette about Species Codes under the Article heading.

The cool thing about this article is that it is a vignette, so is also listed in the R package with vignette(package = "naturecounts")

[steffilazerte]

Hi Denis, if you think the site layout will work, we can start a list here of Articles/Tutorials to include (we can both edit this comment). This is roughly what I've been thinking about, in no particular order. Add/edit this comment as you see fit!

• Brief 'Getting started' tutorial (will be on the main page, and in the README on the GitHub repository)
• Data Access (On Sandbox)
• How to find species_id codes
• How to use region codes
• How to map observations
• How to download observations from a particular region
  • How to clip observations to a shape file
• Exploring BCRs and IBAs
• Filtering data after the download
• Adding in weather data (weathercan example) (DRAFT)
• SQLite database usage
  • How to add different field indices to the SQL database
  • Exploring and joining metadata tables
• Reproducible science with naturecounts (how to keep track of your data)
• Advanced usage
  • Selecting columns and fields to download
    
  • Using the zero-fill function
• FAQ

[steffilazerte]

@DMEthier @dimimarkou, I just stumbled on this old issue. Perhaps some of these ideas are still valid?