-
Notifications
You must be signed in to change notification settings - Fork 0
Review Process and Webpage Development
This is the next phase of work once all of the steps in the Data Generation and Visualization instructions have been completed by the analyst. The information in this page applies to the analyst creating the material, the data reviewer(s), the planning reviewer(s), and the webpage developer.
Once the various outputs and scripts have been saved/moved to the correct locations (see Step 5.5 in Data Generation and Visualization) and the last tab (Production & Review) in the the spreadsheet on Teams (Teams: Equity Tracker > General > Files > Indicator Selection Process > IndicatorResearch_08222023) has been updated, the analysit can let the project team know that their indicator is ready for review in the Equity Tracker teams group.
The first round of review will be conducted by someone familiar with data on the Equity Tracker project team. The goal of this first round of review is to read through the drafted 'data call outs' and 'insights & analysis' sections to make sure the information is reasonable and clear enough (are the values rounded correctly? do the call outs and insights reflect what is shown in the visuals? etc.)
For the data reviewer:
- Let the equity tracker project team know that you are reviewing the specific indicator so that you are the only one to open the word document
- Open the .docx file in the Y drive (Y:\Equity Indicators\X-theme\X##-indicator-name\X##-indicator-name.docx). You can also open the .html file (same location) to be able to interact with the map and charts since the visuals in .docx file are static
- Save and rename the .docx as X##-indicator-name-reviewed.docx (adding -reviewed after the indicator name) - this prevents potential overwriting when the 'vis' script is re-knitted with edits later on in the process
- Set to 'Track Changes' - there are multiple ways to do this in Word (like, Review in the ribbon tab > Track Changes > For Everyone or Reviewing drop down menu)
- Start reading through the document, making changes or comments as needed. If something is unclear flag it for the analyst. If you have questions leave them in comments.
- Once you are finished, update the spreadsheet on Teams (last tab: Production & Review) by adding an 'X' in the 'Review Complete' column (J)
- Although you have completed the first round of reivew, stay tuned! The analyst may need to ask you to clarify one of your commments or may want to work with you to workshop phrasing or a concept
Once the material has been reviewed, the analyst should review the track changes and comments in the .docx file (Y:\Equity Indicators\X-theme\X##-indicator-name\X##-indicator-name-reviewed.docx). This part of the review process will be a chance for analysts to review and respond to any of the comments made by the reviewer(s). They may need to ask the reviewer(s) a quesion or discuss comments or suggestions that the reviewer(s) made.
Based on the reviewer's comments, the analyst may need to edit their visuals (map and/or charts). After making the necessary updates to the code, the analyst will need to re-knit their vis script as HTML [comment out the code: output_type <- "word" and then 'Knit to HTML'].
Once they have knitted to HTML, they will run the two code chunks below to move the files from GitHub > Y drive and then copy the visuals from Y drive > the website development folder (like in step 5 of the Data Generation and Visualization instructions). If this step isn't completed, the updated visuals will not be embedded into the webpage.
You may run into an error when trying to run the two 'Transfer files' code chunks. This is likely because the directory variables weren't set if you only knitted the code to recreate the visuals. To fix this, you need to run the chunk of code where you set the base_dir, theme_dir, ind_dir variables earlier on in the script. Once these are stored, you can run the two chunks.
If the reviewer comments are text-based edits, the analyst does not need to re-knit their vis script because the webpage developer will use the tracked changes in the word document to populate the webpage. They will need to make sure the .docx reflects the final version of the values/phrasing so that it is clear and the webpage developer can easily interpret what to include on the indicator webpages.
The analyst will let people in the Equity Tracker teams group know that the indicator is ready to be migrated to the website. This will initiate the next step - migrating information to the website.
The webpage developer assigned to the indicator will create the webpage and add the content as it appears in the .docx file. They will also embed the visuals from the website development folder (oustide the agency's firewall).
Once completed, the webpage developer will update the spreadsheet on Teams (last tab: Production & Review) by adding an 'X' in the appropriate columns (K-N).
The webpage developer will also update the planning review form (Y:\Equity Indicators\tracker-webpage-content\X-theme\X##-indicator-name\X##-webpage-review-edits.docx) with their name.
With the webpage drafted, the next phase of review can start which includes someone in the planning teams who is familiar with the theme/indicator. This individual will receive instructions on how to conduct their review, including the website reviewer login information. They will be using a .docx to provide their feedback on each indicator webpage (Y:\Equity Indicators\tracker-webpage-content\X-theme\X##-indicator-name\X##-webpage-review-edits.docx). The initial information in this form will have already been filled out by the analyst, such as theme, indicator, analyst name, webpage developer name, etc.
There is an additional thematic-level review form (Y:\Equity Indicators\tracker-webpage-content\X-theme\X-thematic-webpage-review.docx) that only needs to be filled out once after review of the thematic level webpage. Because the place-holder text reflects the economy theme, this may require the reviewer to provide appropriate text for their theme.
Based on the edits made by the planning reviewer(s), the webpage developer will modify the text on the webpage.
Once completed, the webpage developer can update the spreadsheet on Teams (last tab: Production & Review) by adding an 'X' in the appropriate columns (Q).
This step may be a little delayed depending on the amount of webpage editing required. The goal of this step is to make sure that the text in the 'vis' script reflects the final webpage (once all the edits are complete and everyone is happy with the content). This will require the analyst to go onto the webpage, copy the finalized 'data call outs' and 'insights & analysis' sections text, and replace the text in the .Rmd (GitHub\equity-tracker\data-visualization\tracker-webpage-content\X-theme\X##-indicator-name\X##-vis-indicator-name.Rmd).
This step, although a bit redundant, will help with future updates to make sure that the language is consistent and phrased correctly.
No running or knitting is required - just save the updated .Rmd to GitHub and commit the changes through GitHub desktop.
Once completed, the analyst can update the spreadsheet on Teams (last tab: Production & Review) by adding an 'X' in the appropriate columns (R).