Skip to content

Commit

Permalink
update README to include forecasts workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
ernestguevarra committed Sep 8, 2024
1 parent 6857abd commit 19b6c14
Show file tree
Hide file tree
Showing 14 changed files with 45 additions and 3,290 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ data-raw/cyclones
data
!data/.gitkeep
README.html
README_files
12 changes: 5 additions & 7 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@ paglaom
|-- _targets_heat.R
|-- _targets_setup.R
|-- _targets.R
|-- _targets.yaml
```

* `.github` contains project testing and automated deployment of outputs workflows via continuous integration and continuous deployment (CI/CD) using Github Actions.
Expand All @@ -90,9 +89,6 @@ paglaom

* `_targets*.R` files define the steps in the workflow's data ingest, data processing, data analysis, and reporting pipelines.

* `_targets.yaml` file defines the different targets sub-projects within this project.


## Reproducibility

### R package dependencies
Expand All @@ -113,9 +109,11 @@ Currently, the project has workflows that curate the following datasets:

2. Daily heat index data from various data collection points in the Philippines;

3. Climatological extremes and normals data over time; and,
3. Climatological extremes and normals data over time;

4. Daily dam water level data; and,

4. Daily dam water level data.
5. Daily weather forecasts.

The following diagram illustrates these workflows

Expand All @@ -124,7 +122,7 @@ cat(
"```mermaid",
targets::tar_mermaid(
targets_only = TRUE,
names = dplyr::starts_with(c("climate_", "cyclone_", "cylones_", "dam_", "heat_")),
names = dplyr::starts_with(c("climate_", "cyclone_", "cylones_", "dam_", "heat_", "forecasts_")),
color = FALSE, legend = FALSE
),
"```",
Expand Down
87 changes: 39 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,6 @@ The project repository is structured as follows:
|-- _targets_heat.R
|-- _targets_setup.R
|-- _targets.R
|-- _targets.yaml

- `.github` contains project testing and automated deployment of
outputs workflows via continuous integration and continuous
Expand Down Expand Up @@ -150,9 +149,6 @@ The project repository is structured as follows:
- `_targets*.R` files define the steps in the workflow’s data ingest,
data processing, data analysis, and reporting pipelines.

- `_targets.yaml` file defines the different targets sub-projects
within this project.

## Reproducibility

### R package dependencies
Expand Down Expand Up @@ -180,50 +176,41 @@ Currently, the project has workflows that curate the following datasets:
2. Daily heat index data from various data collection points in the
Philippines;

3. Climatological extremes and normals data over time; and,
3. Climatological extremes and normals data over time;

4. Daily dam water level data; and,

4. Daily dam water level data.
5. Daily weather forecasts.

The following diagram illustrates these workflows

\-|/-|/-| `mermaid graph LR style Graph fill:#FFFFFF00,stroke:#000000;
subgraph Graph direction LR
x56bd7c118ed46a38(["heat_index_links"]):::outdated -->
x113a83dcec46090f(["heat_index_links_urls"]):::outdated
x567709ab5f0adc71(["heat_index_pubfiles_url"]):::uptodate -->
x56bd7c118ed46a38(["heat_index_links"]):::outdated
xc044beb81380bb4a["climate_download_files"]:::uptodate -->
x42da7c0722c063a6(["climate_data_normals_1991_2020"]):::outdated
xc044beb81380bb4a["climate_download_files"]:::uptodate -->
xe06460aefd475ca2(["climate_data_extremes_2020"]):::outdated
xc044beb81380bb4a["climate_download_files"]:::uptodate -->
xc83b489a1c433852(["climate_data_extremes_2021"]):::outdated
xc044beb81380bb4a["climate_download_files"]:::uptodate -->
x9b64b30afbfc8ff9(["climate_data_extremes_2022"]):::outdated
xc044beb81380bb4a["climate_download_files"]:::uptodate -->
xf620d5783ff15609(["climate_data_extremes_2023"]):::outdated
x26b861c7a0a21b52["climate_pdf_urls"]:::uptodate -->
xc044beb81380bb4a["climate_download_files"]:::uptodate
x7255575025352eb6(["dam_level_data_files"]):::uptodate -->
xd2c3c65ab78d2c70(["dam_level_data_processed"]):::uptodate
x0de96327cc07b160(["dam_level_data"]):::outdated -->
x202d34e7af3ea1c1(["dam_level_data_raw_csv"]):::outdated
xd2c3c65ab78d2c70(["dam_level_data_processed"]):::uptodate -->
xfa0b497de91938bb(["dam_level_data_csv"]):::outdated
x56bd7c118ed46a38(["heat_index_links"]):::outdated -->
xc432bd4e21a7b9fa(["heat_index_links_dates"]):::outdated
xa37a01adfb45bd68(["climate_directory_urls"]):::uptodate -->
x26b861c7a0a21b52["climate_pdf_urls"]:::uptodate
xc432bd4e21a7b9fa(["heat_index_links_dates"]):::outdated -->
x4f749438c4164b8e["heat_index_download_files"]:::outdated
x113a83dcec46090f(["heat_index_links_urls"]):::outdated -->
x4f749438c4164b8e["heat_index_download_files"]:::outdated
xb48a3b157c96bffd(["climate_pubfiles_url"]):::uptodate -->
xa37a01adfb45bd68(["climate_directory_urls"]):::uptodate
xc77bb431ac7c3081(["dam_level_url"]):::uptodate -->
x0de96327cc07b160(["dam_level_data"]):::outdated
x6f87cfcc96bb274d(["cyclone_reports_links"]):::outdated -->
x1cf596d0c4f824b5["cyclone_reports_download_files"]:::outdated end`
``` mermaid
graph LR
style Graph fill:#FFFFFF00,stroke:#000000;
subgraph Graph
direction LR
x56bd7c118ed46a38(["heat_index_links"]):::outdated --> xc432bd4e21a7b9fa(["heat_index_links_dates"]):::outdated
x26b861c7a0a21b52["climate_pdf_urls"]:::uptodate --> xc044beb81380bb4a["climate_download_files"]:::uptodate
xc77bb431ac7c3081(["dam_level_url"]):::uptodate --> x0de96327cc07b160(["dam_level_data"]):::outdated
x6f87cfcc96bb274d(["cyclone_reports_links"]):::outdated --> x1cf596d0c4f824b5["cyclone_reports_download_files"]:::outdated
xc432bd4e21a7b9fa(["heat_index_links_dates"]):::outdated --> x4f749438c4164b8e["heat_index_download_files"]:::outdated
x113a83dcec46090f(["heat_index_links_urls"]):::outdated --> x4f749438c4164b8e["heat_index_download_files"]:::outdated
xa37a01adfb45bd68(["climate_directory_urls"]):::uptodate --> x26b861c7a0a21b52["climate_pdf_urls"]:::uptodate
xc044beb81380bb4a["climate_download_files"]:::uptodate --> x42da7c0722c063a6(["climate_data_normals_1991_2020"]):::outdated
xd2c3c65ab78d2c70(["dam_level_data_processed"]):::uptodate --> xfa0b497de91938bb(["dam_level_data_csv"]):::outdated
x0de96327cc07b160(["dam_level_data"]):::outdated --> x202d34e7af3ea1c1(["dam_level_data_raw_csv"]):::outdated
xb48a3b157c96bffd(["climate_pubfiles_url"]):::uptodate --> xa37a01adfb45bd68(["climate_directory_urls"]):::uptodate
xc11d790635c14420(["forecasts_pubfiles_urls"]):::uptodate --> x7dd7e06e8ff4bc40["forecasts_download_files"]:::uptodate
x28812d8ea4d86f19(["forecasts_archive_pdfs"]):::uptodate --> xcfcf871ca951fc3f["forecasts_data_raw"]:::uptodate
x56bd7c118ed46a38(["heat_index_links"]):::outdated --> x113a83dcec46090f(["heat_index_links_urls"]):::outdated
x7255575025352eb6(["dam_level_data_files"]):::uptodate --> xd2c3c65ab78d2c70(["dam_level_data_processed"]):::uptodate
x567709ab5f0adc71(["heat_index_pubfiles_url"]):::uptodate --> x56bd7c118ed46a38(["heat_index_links"]):::outdated
xc044beb81380bb4a["climate_download_files"]:::uptodate --> xe06460aefd475ca2(["climate_data_extremes_2020"]):::outdated
xc044beb81380bb4a["climate_download_files"]:::uptodate --> xc83b489a1c433852(["climate_data_extremes_2021"]):::outdated
xc044beb81380bb4a["climate_download_files"]:::uptodate --> x9b64b30afbfc8ff9(["climate_data_extremes_2022"]):::outdated
xc044beb81380bb4a["climate_download_files"]:::uptodate --> xf620d5783ff15609(["climate_data_extremes_2023"]):::outdated
end
```

To run any of these workflows, run the following command on the R
console:
Expand Down Expand Up @@ -280,10 +267,14 @@ will run all targets in the cyclones and dam levels data workflow.
The project also has a workflow for weekly GitHub release of the various
raw datasets.

\-|/-|/- `mermaid graph LR style Graph fill:#FFFFFF00,stroke:#000000;
subgraph Graph direction LR
x8e2305bde709e13c(["paglaom_weekly_release_tag"]):::outdated -->
x2ee1cead5469690e(["paglaom_weekly_release"]):::outdated end`
``` mermaid
graph LR
style Graph fill:#FFFFFF00,stroke:#000000;
subgraph Graph
direction LR
x8e2305bde709e13c(["paglaom_weekly_release_tag"]):::outdated --> x2ee1cead5469690e(["paglaom_weekly_release"]):::outdated
end
```

## Author

Expand Down
Loading

0 comments on commit 19b6c14

Please sign in to comment.