RConsortium / rconsortium_website

http://r-consortium.org/
0 stars 1 forks source link

Development Server for R Consortium Website

This is a new Quarto-based website which updates and supersedes the original website here: archive.r-consortium.org

Contributing to this website

This website is being built members of the R Consortium, R-Ladies Gaborone and other volunteer contributors. Thank you! If you want to help contribute to the site, please use the following workflow.

Workflow for making contributions

1. Clone this website

2. Make a branch

Make a branch and edit your branch locally.

To preview the website locally you can execute this quarto command in your terminal:

3. Commit your changes

Make your changes locally save them and commit them. Be sure to make your commit message descriptive of the work you did.

4. Do a Pull Request

Do a pull request from your local copy to make sure branch is in sync with the website branch. We will review your Pull Request!

What is the R Consortium?

The R Consortium, Inc. is a group organized under an open source governance and foundation model to support the worldwide community of users, maintainers and developers of R software. Its members include leading institutions and companies dedicated to the use, development and growth of R.

The R language is an open source environment for statistical computing and graphics. The R community has enjoyed significant growth, with more than 2 million users worldwide. A broad range of organizations have adopted the R language as a data science platform, including biotech, finance, research and high technology industries. The R language is often integrated into third-party analysis, visualization and reporting applications, and runs on a wide variety of computing platforms.

The R Consortium’s mission is to promote the R language and to develop the technical and social infrastructure required to support the R ecosystem and the R Community. Its activities and programs include:

Promoting the growth and development of R as a leading platform for data science and statistical computing. Members of the R Consortium are recognized as supporters of the R Project and the R community, and the R Consortium represents its members to the R community and to the media. Supporting and collaborating with the R Foundation, the governing body of the R Project.

The R Foundation maintains a permanent seat on the board of the R Consortium, as an open communication channel for R Consortium members.

Funding projects to enhance R and support its users.

Projects are proposed by the R community at large, and selected for funding by the Infrastructure Steering Committee. R Consortium members nominate the selection committee and provide funds for project grants with their membership dues. (Here is a list of projects funded by the R Consortium to date.)

Fostering the continued growth of R community and the data science ecosystem.

The R Consortium sponsors R-related conferences (including useR!), meetings (including SatRDays and RLadies), and local user groups worldwide.

Enabling the use of R in commercial environments, and fostering collaboration between companies investing in R.
R Consortium committees are developing programs for R language certification and training, consulting, and employment.

The mission of the R Consortium is formally defined in the R Consortium bylaws (PDF) and the Infrastructure Steering Committee charter (PDF).

Main Links

Main Site: https://www.r-consortium.org/
News: https://www.r-consortium.org/news
Blog: https://www.r-consortium.org/news/blog
Join: https://www.r-consortium.org/about/join
Twitter: https://twitter.com/rconsortium?lang=en
LinkedIn: https://www.linkedin.com/company/r-consortium/
Mastodon: https://fosstodon.org/@RConsortium


Development Section

Running locally

Clone repo

Use quarto preview to run locally. Ensure you are in the root directory of the Quarto project where the _quarto.yml file is located.

If you use quarto serve you may get the error:

ERROR: No input passed to serve. If you are attempting to preview a website or book use the quarto preview command instead.

Setup for Contributors

Install R using sudo apt-get install r-base and sudo apt-get install r-base-dev

Install R packages on Linux; type R in console and then install.packages('rmarkdown')

GGPLOT2 installation: install.packages("ggplot2")

dygraphs installation : install.packages("dygraphs")

Project Setup

The .gitignore of this project is setup to ignore _site/, .quarto/ and docs

gitignore

Quarto Workflow Notes

R Studio Workflow

Make sure you have R Studio installed.

Clone down this Github repo (public repo). Make sure to pull down the new changes on main.

Open the quarto-blog-dev project in R Studio (File → Open Project). Ensure that you’ve switched to a new branch. git checkout -b name_branch

Install renv with install.packages(“renv”) in console

Run renv::restore() in console

Open a file for testing. Make edits to the file and run renderin R studio to view the updates.

See Final Steps below.

VSCode Workflow

If you’re using VS Code, start R.

Install R languageserver when prompted.

Install packages for R extension on VS Code.

Run install.packages("renv") and renv::restore() in the terminal.

Make edits to a file and run quarto render and quarto preview to see the changes.

See Final Steps below.

Final Steps

Once finished with editing, run git add, git commit, and git push to the branch.

Make a pull request and assign a reviewer. The reviewer should test the request locally by switching to the test branch. Runquarto render and quarto preview to view the site locally.

Once the pull request is accepted, view the workflow status run in GitHub actions.