Skip to content

Commit

Permalink
Merge pull request #19 from NOAA-EDAB/dev
Browse files Browse the repository at this point in the history
Template + Admin changes
  • Loading branch information
BBeltz1 committed Sep 18, 2023
2 parents 37413e9 + 7507cb3 commit 1e08776
Show file tree
Hide file tree
Showing 6 changed files with 116 additions and 67 deletions.
75 changes: 41 additions & 34 deletions .github/ISSUE_TEMPLATE/catalog_submission.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,46 @@ body:
value: "Ex: The data presented here are average annual sea-surface temperatures from PSL OISST on the Northeast Continental Shelf."
validations:
required: true
- type: textarea
id: indicator_intro
attributes:
label: Introduction to Indicator
description: Please introduce the indicator within an appropriate context.
value: "Proceed as though this were a short summary of a typical introduction section in a paper."
validations:
required: false
- type: textarea
id: indicator_results
attributes:
label: Key Results and Visualization
description: Please describe the results and/or visualizations of this indicator.
value: "Proceed as though this were a short summary of a typical results section in a paper."
validations:
required: false
- type: textarea
id: indicator_implications
attributes:
label: Implications
description: Please describe the implications of this indicator.
value: "Proceed as though this were a short summary of a typical discussion section in a paper."
validations:
required: false
- type: input
id: spatial_scale
attributes:
label: Spatial Scale
description: Please briefly describe the spatial scale of the indicator.
placeholder: ex. by EPU and full shelf.
validations:
required: false
- type: input
id: temporal_scale
attributes:
label: Temporal Scale
description: Please briefly describe the temporal scale of the indicator.
placeholder: ex. Spring (January-June), Fall (July-December), Annual.
validations:
required: false
- type: checkboxes
id: synthesis_theme
attributes:
Expand Down Expand Up @@ -114,37 +154,4 @@ body:
description: If source data are NOT publicly available, what are the procedures for accessing the data?
placeholder: Ex. Please email [email protected] for further information and queries of X indicator source data.
validations:
required: false
- type: markdown
attributes:
value: "## Methods"
- type: markdown
attributes:
value: |
In the following sections, please outline the methods used for these indicator data. Please include any documentation when available (i.e. links to code, published works, etc). If easier, you may include a write up of your methods in a separate document and upload that file below.
- type: textarea
id: data_source
attributes:
label: Data Source(s)
description: Describe data sources here, with links wherever applicable.
validations:
required: true
- type: textarea
id: data_processing
attributes:
label: Data Processing
description: How were data processed? At minimum, please include a text description of the processing steps. Code may be uploaded as a supporting file below. If code is published elsewhere, please provide a link.
validations:
required: false
- type: textarea
id: data_analysis
attributes:
label: Data Analysis
description: How were the data analyzed? Please provide a description of analytical methods, upload any relevant code and/or link to appropriate sources. At minimum, please include a text description of the analytical steps. Code may be uploaded as a supporting file below.
validations:
required: false
- type: textarea
id: bibliography
attributes:
label: Bibiography
description: Use this space to enter citations for above fields, preferably in BibTeX format. Otherwise, please upload a bibliography as a supporting file below.
required: false
13 changes: 13 additions & 0 deletions .github/workflows/secretScan.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: gitleaks

on: [push,pull_request]

jobs:
gitleaks:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: '0'
- name: gitleaks-action
uses: zricethezav/[email protected]
1 change: 1 addition & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Type: Book
Title: Synthetic Indicator Cataloque
Description: Catalogue containing indicator used in the State of the Ecosystem Report and Beyond...
Version: 1.0.0
License: file LICENSE
Depends:
bookdown,
rmarkdown,
Expand Down
8 changes: 8 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
“Software code created by U.S. Government employees is not subject to
copyright in the United States (17 U.S.C. §105). The United States/Department
of Commerce reserve all rights to seek and obtain copyright
protection in countries other than the United States for Software authored
in its entirety by the Department of Commerce. To this end, the Department
of Commerce hereby grants to Recipient a royalty-free, nonexclusive
license to use, copy, and create derivative works of the Software outside
of the United States.”
35 changes: 32 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,36 @@
---
editor_options:
markdown:
wrap: 72
---

# [Synthetic Indicator Catalog](https://noaa-edab.github.io/catalog/)
Catalog of indicators used in the State of the Ecosystem reports and other ecosystem assessment products.

This book is in development.
![gitleaks](https://github.com/NOAA-EDAB/catalog/workflows/gitleaks/badge.svg)

Catalog of indicators used in the State of the Ecosystem reports and
other ecosystem assessment products.

This book is in development.

## Contact

| [Brandon-Beltz](https://github.com/BBeltz1)
|--------------------------------
| [![](https://avatars.githubusercontent.com/u/136381970?s=100&u=b65aaafd27d4c925988755e61e497e2e7d573622&v=4)](https://github.com/BBeltz1) |

#### Legal disclaimer

*This repository is a scientific product and is not official communication of the National Oceanic and Atmospheric Administration, or the United States Department of Commerce. All NOAA GitHub project code is provided on an ‘as is’ basis and the user assumes responsibility for its use. Any claims against the Department of Commerce or Department of Commerce bureaus stemming from the use of this GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.*
*This repository is a scientific product and is not official
communication of the National Oceanic and Atmospheric Administration, or
the United States Department of Commerce. All NOAA GitHub project code
is provided on an 'as is' basis and the user assumes responsibility for
its use. Any claims against the Department of Commerce or Department of
Commerce bureaus stemming from the use of this GitHub project will be
governed by all applicable Federal law. Any reference to specific
commercial products, processes, or services by service mark, trademark,
manufacturer, or otherwise, does not constitute or imply their
endorsement, recommendation or favoring by the Department of Commerce.
The Department of Commerce seal and logo, or the seal and logo of a DOC
bureau, shall not be used in any manner to imply endorsement of any
commercial product or activity by DOC or the United States Government.*
51 changes: 21 additions & 30 deletions packages.bib
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@ @Manual{R-dplyr
title = {dplyr: A Grammar of Data Manipulation},
author = {Hadley Wickham and Romain François and Lionel Henry and Kirill Müller},
year = {2022},
note = {R package version 1.0.10},
note = {R package version 1.0.9},
url = {https://CRAN.R-project.org/package=dplyr},
}

@Manual{R-DT,
title = {DT: A Wrapper of the JavaScript Library DataTables},
author = {Yihui Xie and Joe Cheng and Xianying Tan},
year = {2022},
note = {R package version 0.23},
note = {R package version 0.24},
url = {https://github.com/rstudio/DT},
}

Expand All @@ -66,15 +66,15 @@ @Manual{R-ggiraph
title = {ggiraph: Make ggplot2 Graphics Interactive},
author = {David Gohel and Panagiotis Skintzos},
year = {2022},
note = {R package version 0.8.2},
note = {R package version 0.8.3},
url = {https://davidgohel.github.io/ggiraph/},
}

@Manual{R-ggplot2,
title = {ggplot2: Create Elegant Data Visualisations Using the Grammar of Graphics},
author = {Hadley Wickham and Winston Chang and Lionel Henry and Thomas Lin Pedersen and Kohske Takahashi and Claus Wilke and Kara Woo and Hiroaki Yutani and Dewey Dunnington},
year = {2022},
note = {R package version 3.4.0},
year = {2023},
note = {R package version 3.4.2},
url = {https://CRAN.R-project.org/package=ggplot2},
}

Expand Down Expand Up @@ -115,7 +115,7 @@ @Manual{R-knitr
title = {knitr: A General-Purpose Package for Dynamic Report Generation in R},
author = {Yihui Xie},
year = {2022},
note = {R package version 1.39},
note = {R package version 1.41},
url = {https://yihui.org/knitr/},
}

Expand All @@ -138,9 +138,8 @@ @Manual{R-miniUI
@Manual{R-patchwork,
title = {patchwork: The Composer of Plots},
author = {Thomas Lin Pedersen},
year = {2020},
note = {R package version 1.1.1},
url = {https://CRAN.R-project.org/package=patchwork},
year = {2023},
note = {https://patchwork.data-imaginist.com},
}

@Manual{R-permute,
Expand All @@ -153,9 +152,9 @@ @Manual{R-permute

@Manual{R-purrr,
title = {purrr: Functional Programming Tools},
author = {Hadley Wickham and Lionel Henry},
year = {2022},
note = {R package version 1.0.0},
author = {Lionel Henry and Hadley Wickham},
year = {2020},
note = {R package version 0.3.4},
url = {https://CRAN.R-project.org/package=purrr},
}

Expand Down Expand Up @@ -187,7 +186,7 @@ @Manual{R-rmarkdown
title = {rmarkdown: Dynamic Documents for R},
author = {JJ Allaire and Yihui Xie and Jonathan McPherson and Javier Luraschi and Kevin Ushey and Aron Atkins and Hadley Wickham and Joe Cheng and Winston Chang and Richard Iannone},
year = {2022},
note = {R package version 2.14},
note = {R package version 2.16},
url = {https://CRAN.R-project.org/package=rmarkdown},
}

Expand All @@ -199,14 +198,6 @@ @Manual{R-rpart
url = {https://CRAN.R-project.org/package=rpart},
}

@Manual{R-rticles,
title = {rticles: Article Formats for R Markdown},
author = {JJ Allaire and Yihui Xie and Christophe Dervieux and {R Foundation} and Hadley Wickham and {Journal of Statistical Software} and Ramnath Vaidyanathan and {Association for Computing Machinery} and Carl Boettiger and {Elsevier} and Karl Broman and Kirill Mueller and Bastiaan Quast and Randall Pruim and Ben Marwick and Charlotte Wickham and Oliver Keyes and Miao Yu and Daniel Emaasit and Thierry Onkelinx and Alessandro Gasparini and Marc-Andre Desautels and Dominik Leutnant and {MDPI} and {Taylor and Francis} and Oğuzhan Öğreden and Dalton Hance and Daniel Nüst and Petter Uvesten and Elio Campitelli and John Muschelli and Alex Hayes and Zhian N. Kamvar and Noam Ross and Robrecht Cannoodt and Duncan Luguern and David M. Kaplan and Sebastian Kreutzer and Shixiang Wang and Jay Hesselberth and Rob Hyndman},
year = {2022},
note = {R package version 0.24},
url = {https://github.com/rstudio/rticles},
}

@Manual{R-servr,
title = {servr: A Simple HTTP Server to Serve Static Files or Dynamic Documents},
author = {Yihui Xie},
Expand All @@ -219,7 +210,7 @@ @Manual{R-sf
title = {sf: Simple Features for R},
author = {Edzer Pebesma},
year = {2022},
note = {R package version 1.0-8},
note = {R package version 1.0-7},
url = {https://CRAN.R-project.org/package=sf},
}

Expand All @@ -234,32 +225,32 @@ @Manual{R-sp
@Manual{R-stringr,
title = {stringr: Simple, Consistent Wrappers for Common String Operations},
author = {Hadley Wickham},
year = {2019},
note = {R package version 1.4.0},
year = {2022},
note = {R package version 1.5.0},
url = {https://CRAN.R-project.org/package=stringr},
}

@Manual{R-tibble,
title = {tibble: Simple Data Frames},
author = {Kirill Müller and Hadley Wickham},
year = {2022},
note = {R package version 3.1.8},
year = {2023},
note = {R package version 3.2.1},
url = {https://CRAN.R-project.org/package=tibble},
}

@Manual{R-tidyr,
title = {tidyr: Tidy Messy Data},
author = {Hadley Wickham and Maximilian Girlich},
year = {2022},
note = {R package version 1.2.1},
note = {R package version 1.2.0},
url = {https://CRAN.R-project.org/package=tidyr},
}

@Manual{R-tidyverse,
title = {tidyverse: Easily Install and Load the Tidyverse},
author = {Hadley Wickham},
year = {2022},
note = {R package version 1.3.2},
year = {2021},
note = {R package version 1.3.1},
url = {https://CRAN.R-project.org/package=tidyverse},
}

Expand All @@ -275,7 +266,7 @@ @Manual{R-webshot
title = {webshot: Take Screenshots of Web Pages},
author = {Winston Chang},
year = {2022},
note = {R package version 0.5.3},
note = {R package version 0.5.4},
url = {https://CRAN.R-project.org/package=webshot},
}

Expand Down

0 comments on commit 1e08776

Please sign in to comment.