MazamaScience / MazamaSatelliteUtils

Satellite Data Download and Utility Functions
http://mazamascience.github.io/MazamaSatelliteUtils
GNU Lesser General Public License v3.0
0 stars 0 forks source link

Update and flesh out vignette docs #73

Closed lagerratrobe closed 3 years ago

lagerratrobe commented 4 years ago

There's a great deal of good information currently in the vignettes, but it needs to be re-worked.

  1. 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

  2. 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.

  3. 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.

lagerratrobe commented 4 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~

  1. How MazSatUtils Works ~1. Importance of time and SatID~ a. DayTime ~b. Timezones and relationship between local time and UTC~ ~c. SatID and geographic location~
    1. Downloads and File listing
    2. Creation of Spatial Grids a. How grids work and why they're needed
    3. extraction of raw AOD data, unpacking and scaling
    4. Conversion to decimal lat/lon values
    5. Brief description of available AOD "products" a. NativeGrid b. Tibble c. SpatialPoints d. Raster e. RasterStack f. LocationTimeSeries g. AreaPlot h. Video

IV. Working with AOD Data Structures A. NativeGrid

  1. Examples B. Tibble
  2. Examples C. Spatial Points
  3. Examples D. Raster
  4. Examples E. RasterStack
  5. Examples F. LocationTimeSeries
  6. Examples G. AreaPlot
  7. Examples H. Video
  8. Examples I. Combining AOD and Monitor Data J. Overlaying monitoring data values
  9. Examples K. Extracting values at a location
  10. Examples

V. Special Cases/Gotchas?

lagerratrobe commented 4 years ago

https://docs.google.com/document/d/1J0XFS6dqUeRIPk678rZlRHlnJHPgNuXSc00yGBZ1m_8/edit?usp=sharing

lagerratrobe commented 4 years ago

Images.

3D_netcdf