progress_of: The progress made for each season's worth of data

View source: R/report_functions.R

progress_ofR Documentation

The progress made for each season's worth of data

Description

progress_of queries the UWIN database for a selected study area.

Usage

progress_of(studyArea = NULL, db = uwidb)

Arguments

studyArea

The four letter capitalized study area abbreviation for a city. If left as NULL you can select the study area from a pop up list. Only one study area may be selected at a time.

db

The MySQL connection to the UWIN database. Defaults to 'uwidb'

Value

a list with the following elements:

- assignedIncomplete (data.frame): This is a report on photo groups that have been assigned but have yet to be finished. The columns in assingedIncomplete are:

  • User: The name of the person who has photo groups to classify.

  • email: The users email.

  • yearMonth: The year and month of visits in the database that have photos.r

  • countAssignedIncomplete: The number of photo groups assigned to a user per yearMonth that have not been completed.

- fullComplete (data.frame): This is a progress report on the images that have been classified as 'complete' in the cloud database, which depends on how many users are necessary to consider an image 'complete' (either one or two, depending on a study area). The columns in fullComplete are:

  • yearMonth: The year and month of visits in the database that have photos.

  • percentComplete: The percent of images in a yearMonth that are considered 100

  • TotalPhotos: The number of photos tied to a yearMonth.

  • NotAssigned: Photos in a yearMonth that have not been assigned to a user to tag.

  • ToValidate: The number of photos that need to go through Validation per yearMonth. The Valdidation is on the UWIN cloud db.

- pendingComplete (data.frame): This is a progress report on the images that have been tagged by at least one user on the cloud db, which could be used to generate an occupancy query (assuming that 1 viewer is okay). The columns in pendingComplete are:

  • yearMonth: The year and month of visits in the database that have photos.

  • percentComplete: The percent of images in a yearMonth that have been tagged at least once.

  • TotalPhotos: The number of photos tied to a yearMonth.

  • NotAssigned: Photos in a yearMonth that have not been assigned to a user to tag.

Examples

## Not run: 
my_images <- progress_of("CHIL")

## End(Not run)

mfidino/uwinutils documentation built on June 11, 2025, 1:49 p.m.