Closed lagerratrobe closed 3 years ago
Updated with feedback from Google Doc.
~1. Introduction to MazamaSatelliteUtils~ ~A. What is it~ ~B. What is the purpose and who is the intended user~ ~C. Requirements for using the package~
~2. Introduction to GOES AOD Data~ ~A. Overview of GOES 16 & 17~ ~B. Temporal nature of data and relationship to geostationary satellite~ ~C. Other Products available from GOES~ ~D. Overview of AOD~ ~1. What is AOD.~ ~2. Instrument range and units~ ~3. Places where AOD is not calculated~ ~4. What do the numbers mean~ ~5. What is DQF and why is it important~ ~6. How geographic location impact data quality~
~3. Data Dictionary~ ~A. What is a NetCDF?~ ~1. Data format~ ~2. Dimensions~
IV. Working with AOD Data Structures A. NativeGrid
V. Special Cases/Gotchas?
Images.
There's a great deal of good information currently in the vignettes, but it needs to be re-worked.
We need an outline of what information we think should be in the docs. This will allow us to reorganize and consolidate topics that have already been written about, and to figure out what needs to be added
The writing style in the Vignettes currently is not uniform. The sections that we choose to keep need to be written in a manner consistent with what a scientific user would expect.
The examples in the vignettes currently were written early in the development of the project and in some cases use color ramps which no longer work well with the AOD ranges now being produced. Also, in some cases the geographic region shown in the plot could be changed to more effectively capture a fire region.