Documentation - Githubissues

nmtarr / SEWoodyWetlandAnalysis

Code for an analysis of GAP species, land cover, and protected area data that assesses the importance of woody wetlands in the Southeast for wildlife species and identifies wetland-dependent species and locations where they are most species rich.

Other

1 stars 0 forks source link

Documentation #5

Open nmtarr opened 6 years ago

nmtarr commented 6 years ago

Are the methods sufficiently documented for the audience, and do they meet USGS requirements?

albenson-usgs commented 5 years ago

This may not be the exact right place for this but the first sentence of paragraph 6 in the introduction "Many wildlife species avoid areas dominated by human land use (i.e. croplands and urban areas) so woody wetlands likely provide valuable habitat to wildlife populations in the region;" seems like it needs a reference to support this statement. It's a key assumption for your analysis.

albenson-usgs commented 5 years ago

For the sentence "We investigated relationships between wildlife habitat and southeastern woody wetlands at a national scale." I think you need to give some indication that these are assumed wildlife habitat, especially because people can't view for themselves the connections being made between particular species and the relationships to the habitats they occupy (right? The WHRD is not something other people can look at?).

dwief-usgs commented 5 years ago

Suggestions for readMe.rst

There are a few sections missing from suggested BAP documentation. See Tests and Citations sections. Having a stakeholder with a specific use case question will help develop out a "test" of if the BAP is meeting needs or not.
In the purpose section you need to give a little more explanation of what GAP data refers too.
Sections Inputs&Outputs, constraints and dependencies... it might be good to have a summary in the readme so that someone that lands on this repo can understand general info without leaving the readme... If you take this suggestion I would still leave in your notes notes saying "additional info can be found in X" or "see X for detailed information..."
Low priority => change formatting to make subsections stick out.

-longer term we will need to get input data online and call back info via API or alike... this is the direction we are trying to head with all of our BAPs, but as a group have some work to do

dwief-usgs commented 5 years ago

with many of the datasets not being accessible and/or large files that someone wouldn't necessarily want to run I'd suggest a few things. 1) documenting in readme that this analysis requires X resources to run 2) (not sure it would be worth going down this rabbit hole at this stage but could be helpful to include a small subset so users can understand inputs and processes