update intro page.

Author: Naeemkh

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 70d33d9a7968bb67220977a0118c9c39
+config: a96b3423adedbde1c3a8df9c8e5ec861
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_images/causalgps_logo.svg

@@ -0,0 +1 @@
+# TBD

docs/_images/cre_logo.svg

@@ -0,0 +1,60 @@
+# Contribution
+
+Contributions to any of the NSAPH-Software packages are welcome and strongly encouraged.  These contributions can come in different forms, including but not limited to:
+
+- Adding new features,
+- Improving documentation, 
+- Addressing open issues, 
+- Reporting a bug or requesting a new feature,
+- Fixing typos in the documentation, 
+- Improving logging messages,
+- And many more.
+
+Please read the following documents before making changes to the codebase.
+
+## Git Branching Model
+
+Although, in your personal repository, you can pick any branch name, however, to keep consistency and understand who is working on what, the following convention is strongly recommended. In this project, we follow the convention that Vincent Driessen proposes in his [A successful Git branching model](A successful Git branching model) post.
+
+Here is the summary of the branches:
+
+- **master/main**: master/main branch only hosts the released software packages. Only project maintainers have a write-access on the master/main branch.  
+- **develop**: develop branch is considered the main branch where the source code of HEAD always reflects a state with the latest delivered development changes for the next release.   
+- **supporting branch**: There are different supporting branches; three main supporting branches that we suggest the contributors follow the naming convention include:   
+  - **feature**: we start a new feature branch to add new features to the software. The naming convention is iss[issue_number]_short_description. For example, if I need to add unittest to one of the functions in the package and the issue number is 12, iss12_add_unittest can be a valid git branch name. We start with the issue number to go back and take a look at the issue details if necessary. Although feature branches are temporary, this naming convention helps developers to understand the situation while working on the codebase. If you are working on some features that there is no open issue for that, please open an issue and put a comment that you are working on that issue.    
+
+    ```{note} 
+    It is a good idea to consult with the package maintainers and/or core developers before committing significant time to add new features to make sure that it fits into the short-term and long-term release plans. 
+    ```
+  - **hotfix**: hotfix branches will be only used for fixing a bug on a released package. After fixing the bug, the third digit of the version number should be incremented by one. For example, 2.3.5 –> 2.3.6. These branches will be prefixed with hotfix and followed by the upcoming version number (e.g., in this case, hotfix_2.3.6)    
+  - **release**: Release branches support the preparation of a new production release.    
+
+
+## Submitting a Pull Request (PR)
+
+All pull requests should be submitted to the develop branch of each package. Here is the PR checklist:
+
+- If you added a new feature, make sure that appropriate unittests and documentation are also added.
+- Make sure that you have merged the latest code from the develop branch into your feature branch. 
+- Update the NEWS.md file with the changes that you make (Do not change the version or title of the NEWS.md file).
+- Make sure to clean up white spaces. Read more [here](https://softwareengineering.stackexchange.com/questions/121555/why-is-trailing-whitespace-a-big-deal).
+- Make sure the code passes all tests in your local system.
+- After submitting a PR, please keep an eye on the CI test/check results. If there is a failed test or check, please address them and resubmit.  
+
+
+## Reporting Bugs
+
+Please report potential bugs by opening a new issue in the package repository. Please include the following information in your bug report:
+
+- A brief description of what you are doing, what you expected to happen, and what happened.
+- OS that you are using and whether you are using a personal computer or HPC cluster.
+- The version of the package that you have installed.
+
+## Scientific Discussions
+
+In scientific research, many decisions can still be open research questions. We may choose an approach, document it, and move forward. However, other options can be valid and open to discussion. We strongly encourage contributing to these discussions under each repository's `Discussions` tab.
+
+## Log Messages
+
+All packages come with logging capabilities. Log messages are very important in understanding the internal processes, catching bugs, and developing robust software. If you add new features, please also add logging messages. TODO: Different levels of logging messages.
+

docs/_images/place_holder.svg

@@ -0,0 +1,3 @@
+# Python Styling Guide
+
+TBD

docs/_sources/blog_posts/TBD.md

@@ -0,0 +1,77 @@
+# R Styling Guide
+
+For the R packages, we follow [The tidyverse style guide](https://style.tidyverse.org/). Here are some examples:
+
+## Spaces and Indentation
+
+- Indentations are two spaces (do not use a tab key)
+- Place space around binary operators (e.g., x + y)
+
+```r
+# Acceptable
+z <- x + y 
+
+# Not recommended
+z<-x+y # (no space)
+x<- x+y
+z<-x +y
+```
+
+- Place a space after comma
+
+```r
+# Acceptable
+a <- matrix(c(1:100), nrow = 5)
+
+# Not recommended
+a <- matrix(c(1:100),nrow = 5) # (no space after comma)
+a <- matrix( c(1:100), nrow = 5 ) # (extra space after and before parentheses)
+a<-matrix(c(1:100), nrow = 5) # (no space around unary operator <- )
+```
+
+- Place a space after # and before comments and avoid multiple ###.
+
+```r
+# Acceptable
+# This is a comment.
+
+# Not recommended
+#This is a comment
+#    This is a comment (more than one space after #)
+## This is a comment (multiple #)
+```
+
+- Do not put space at the opening and closing parenthesis
+
+```r
+# Acceptable
+x <- (z + y)
+
+# Not recommended 
+x <- ( z + y )
+x <- (z + y )
+x <- ( z + y)
+```
+
+- Place a space before and after `()` when used with `if`, `for`, or `while`.
+
+```r
+# Acceptable
+
+if (x > 2) {
+  print(x)
+}
+
+# Not recommended
+
+if(x > 2){
+  print(x)
+}
+```
+
+## Other notes
+
+- Maximum line length is 80 character
+- Use explicit returns 
+- Use explicit tags in documentation (e.g., @title, @description, ... )
+

docs/_sources/developers_zone/contribution.md

@@ -0,0 +1,5 @@
+# Styling Guide
+
+- [R Styling Guide](r.md)
+- [Python Styling Guide](python.md)
+

docs/_sources/developers_zone/python.md

@@ -1,11 +1,103 @@
-# Welcome to your Jupyter Book
+# National Studies on Air Pollution and Health Software
 
-This is a small sample book to give you a feel for how book content is
-structured.
-It shows off a few of the major file types, as well as some sample content.
-It does not go in-depth into any particular topic - check out [the Jupyter Book documentation](https://jupyterbook.org) for more information.
+NSAPH Software is a collection of open-source packages to carry out **N**ational **S**tudies on **A**ir **P**ollution and **H**ealth.
 
-Check out the content pages bundled with this sample book to see more.
 
-```{tableofcontents}
+
+````{panels}
+:container: +full-width text-center
+:column: col-lg-4 px-4 py-3
+:footer: text-left
+:card:
+
+---
+
+**[CausalGPS](https://github.com/fasrc/CausalGPS/)**
+^^^
+
+```{figure} figures/svg/causalgps_logo.svg
+:height: 100px
+:name: causalgps
+```
+Matching on generalized propensity scores with continuous exposures
+
+[![](http://www.r-pkg.org/badges/version-last-release/CausalGPS)](http://www.r-pkg.org/pkg/causalgps)
+[![R build status](https://github.com/fasrc/CausalGPS/workflows/R-CMD-check/badge.svg)](https://github.com/fasrc/CausalGPS/actions)
+[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/grand-total/CausalGPS)](http://www.r-pkg.org/pkg/causalgps)
+[![codecov](https://codecov.io/gh/fasrc/CausalGPS/branch/develop/graph/badge.svg?token=97PCUXRGXH)](https://app.codecov.io/gh/fasrc/CausalGPS/)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/NSAPH/R_project_binder/master?urlpath=rstudio)
+
+
+---
+**[pycausalgps](https://github.com/fasrc/pycausalgps/)**
+^^^
+
+```{figure} figures/svg/place_holder.svg
+:height: 100px
+:name: pycausalgps
 ```
+
+Matching on generalized propensity scores with continuous exposures (Python Package)
+
+[![PyPI version](https://img.shields.io/pypi/v/pycausalgps.svg)](https://pypi.org/project/pycausalgps)
+
+---
+**[CRE](https://github.com/NSAPH-Software/CRE/)**
+^^^
+
+```{figure} figures/svg/cre_logo.svg
+:height: 100px
+:name: cre
+```
+
+Interpretable Subgroups Identification through Ensemble Learning of Causal Rules
+
+[![](http://www.r-pkg.org/badges/version-last-release/CRE)](http://www.r-pkg.org/pkg/cre)
+[![R-CMD-check](https://github.com/nsaph-software/CRE/workflows/R-CMD-check/badge.svg)](https://github.com/nsaph-software/CRE/actions)
+[![codecov](https://codecov.io/gh/NSAPH-Software/CRE/branch/develop/graph/badge.svg?token=UMSVOYRKGA)](https://codecov.io/gh/NSAPH-Software/CRE)
+
+---
+**[GPCERF](https://github.com/NSAPH-Software/GPCERF)**
+^^^
+
+```{figure} figures/svg/place_holder.svg
+:height: 100px
+:name: gpcerf
+```
+
+Gaussian processes for the estimation of causal exposure-response curves (GPCERF)
+
+[![](http://www.r-pkg.org/badges/version-last-release/GPCERF)](http://www.r-pkg.org/pkg/gpcerf)
+[![R build status](https://github.com/NSAPH-Software/GPCERF/workflows/R-CMD-check/badge.svg)](https://github.com/NSAPH-Software/GPCERF/actions)
+[![codecov](https://codecov.io/gh/NSAPH-Software/GPCERF/branch/develop/graph/badge.svg?token=066ISL822N)](https://codecov.io/gh/NSAPH-Software/GPCERF)
+
+
+---
+
+**[CCIT](https://github.com/NSAPH-Software/CCIT)**
+^^^
+
+```{figure} figures/svg/place_holder.svg
+:height: 100px
+:name: ccit
+```
+
+Continuous Causal Interaction Tree
+
+[![](http://www.r-pkg.org/badges/version-last-release/CCIT)](http://www.r-pkg.org/pkg/ccit)
+
+---
+
+**[NSAPHUtils](https://github.com/NSAPH-Software/NSAPHutils)**
+^^^
+
+```{figure} figures/svg/place_holder.svg
+:height: 100px
+:name: nsaphutils
+```
+
+Utility R functions and tools for working with data in NSAPH research
+
+[![](http://www.r-pkg.org/badges/version-last-release/CCIT)](http://www.r-pkg.org/pkg/ccit)
+
+````