From e33211635a47c86097ed6c2df96efe8ff55ac230 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kirill=20M=C3=BCller?= Date: Mon, 18 Aug 2025 19:20:12 +0200 Subject: [PATCH 1/8] =?UTF-8?q?=F0=9F=9A=A7=F0=9F=9A=A7=F0=9F=9A=A7=20UNDE?= =?UTF-8?q?R=20CONSTRUCTION=20=F0=9F=9A=A7=F0=9F=9A=A7=F0=9F=9A=A7?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 19 +++++++++++-------- isc-proposal.qmd | 13 +++++++++---- 2 files changed, 20 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 1eeae1c..8353a18 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,29 @@ -# isc-proposal +# 🚧🚧🚧 UNDER CONSTRUCTION: isc-proposal 🚧🚧🚧 + +This repository is currently being revisited. +An update will be released in early September 2025. [![build-status](https://github.com/YOUR-USERNAME/YOUR-REPOSITORY/actions/workflows/publish-proposal.yaml/badge.svg)](https://github.com/YOUR-USERNAME/YOUR-REPOSITORY/actions/workflows/publish-proposal.yaml) This repository is a boilerplate repository that helps you prepare your proposal for the [R Consortium](https://www.r-consortium.org). -## Background +## Background Set up in 2015, the R Consortium is an organisation set up to help support the R Foundation, the R Community, and R users. -> The primary purpose of the R Consortium (collectively, the “Purpose”) is to: +> The primary purpose of the R Consortium (collectively, the “Purpose”) is to: > >(a) advance the worldwide promotion of and support for the R open source language and environment as the preferred language for statistical computing and graphics (the “Environment”); > ->(b) establish, maintain, seek support for, and develop infrastructure projects and technical and infrastructure collaboration initiatives related to the Environment, and such other initiatives as may be appropriate to support, enable and promote the Environment; +>(b) establish, maintain, seek support for, and develop infrastructure projects and technical and infrastructure collaboration initiatives related to the Environment, and such other initiatives as may be appropriate to support, enable and promote the Environment; > ->(c) encourage and increase user adoption, involvement with, and contribution to, the Environment; +>(c) encourage and increase user adoption, involvement with, and contribution to, the Environment; > ->(d) facilitate communication and collaboration among users and developers of the Environment, the R Consortium and the R Foundation for Statistical Computing (the “R Foundation”); +>(d) facilitate communication and collaboration among users and developers of the Environment, the R Consortium and the R Foundation for Statistical Computing (the “R Foundation”); > ->(e) support and maintain policies set by the Board; and +>(e) support and maintain policies set by the Board; and > ->(f) undertake such other activities as may from time to time be appropriate to further the purposes and achieve the goals set forth above. +>(f) undertake such other activities as may from time to time be appropriate to further the purposes and achieve the goals set forth above. > >In furtherance of these efforts, the R Consortium shall seek to solicit the participation of all interested parties on a fair, equitable and open basis. diff --git a/isc-proposal.qmd b/isc-proposal.qmd index 87cf41f..af19b61 100644 --- a/isc-proposal.qmd +++ b/isc-proposal.qmd @@ -1,23 +1,28 @@ --- title: "Proposal Title" -author: +author: - name: Annie Easley orcid: 5555-5555-5555-5555 affiliations: - "Lewis Research Center, National Aeronautics and Space Administration" - + date: today date-format: iso format: html: embed-resources: true hikmah-pdf: - geometry: + geometry: - left=1.25in - right=1.25in bibliography: references.bib --- +# 🚧🚧🚧 UNDER CONSTRUCTION 🚧🚧🚧 + +This repository is currently being revisited. +An update will be released in early September 2025. + {{< include proposal/signatories.qmd >}} {{< include proposal/problemdefinition.qmd >}} @@ -31,4 +36,4 @@ bibliography: references.bib {{< include proposal/success.qmd >}} ::: refs -::: \ No newline at end of file +::: From 7d0a2de74e64135e2117cb1045d67524c8cc849e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kirill=20M=C3=BCller?= Date: Mon, 18 Aug 2025 19:39:13 +0200 Subject: [PATCH 2/8] Rename --- isc-proposal.qmd | 12 ++++++------ proposal/{signatories.qmd => 01-signatories.qmd} | 0 ...roblemdefinition.qmd => 02-problemdefinition.qmd} | 0 proposal/{proposal.qmd => 03-proposal.qmd} | 0 proposal/{timeline.qmd => 04-timeline.qmd} | 0 proposal/{requirements.qmd => 05-requirements.qmd} | 0 proposal/{success.qmd => 06-success.qmd} | 0 7 files changed, 6 insertions(+), 6 deletions(-) rename proposal/{signatories.qmd => 01-signatories.qmd} (100%) rename proposal/{problemdefinition.qmd => 02-problemdefinition.qmd} (100%) rename proposal/{proposal.qmd => 03-proposal.qmd} (100%) rename proposal/{timeline.qmd => 04-timeline.qmd} (100%) rename proposal/{requirements.qmd => 05-requirements.qmd} (100%) rename proposal/{success.qmd => 06-success.qmd} (100%) diff --git a/isc-proposal.qmd b/isc-proposal.qmd index af19b61..eef066f 100644 --- a/isc-proposal.qmd +++ b/isc-proposal.qmd @@ -23,17 +23,17 @@ bibliography: references.bib This repository is currently being revisited. An update will be released in early September 2025. -{{< include proposal/signatories.qmd >}} +{{< include proposal/01-signatories.qmd >}} -{{< include proposal/problemdefinition.qmd >}} +{{< include proposal/02-problemdefinition.qmd >}} -{{< include proposal/proposal.qmd >}} +{{< include proposal/03-proposal.qmd >}} -{{< include proposal/timeline.qmd >}} +{{< include proposal/04-timeline.qmd >}} -{{< include proposal/requirements.qmd >}} +{{< include proposal/05-requirements.qmd >}} -{{< include proposal/success.qmd >}} +{{< include proposal/06-success.qmd >}} ::: refs ::: diff --git a/proposal/signatories.qmd b/proposal/01-signatories.qmd similarity index 100% rename from proposal/signatories.qmd rename to proposal/01-signatories.qmd diff --git a/proposal/problemdefinition.qmd b/proposal/02-problemdefinition.qmd similarity index 100% rename from proposal/problemdefinition.qmd rename to proposal/02-problemdefinition.qmd diff --git a/proposal/proposal.qmd b/proposal/03-proposal.qmd similarity index 100% rename from proposal/proposal.qmd rename to proposal/03-proposal.qmd diff --git a/proposal/timeline.qmd b/proposal/04-timeline.qmd similarity index 100% rename from proposal/timeline.qmd rename to proposal/04-timeline.qmd diff --git a/proposal/requirements.qmd b/proposal/05-requirements.qmd similarity index 100% rename from proposal/requirements.qmd rename to proposal/05-requirements.qmd diff --git a/proposal/success.qmd b/proposal/06-success.qmd similarity index 100% rename from proposal/success.qmd rename to proposal/06-success.qmd From 5a404790a485c4efd55391c6de7cd8b1a3899a4f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kirill=20M=C3=BCller?= Date: Mon, 18 Aug 2025 19:42:13 +0200 Subject: [PATCH 3/8] Typos --- README.md | 6 +++--- proposal/03-proposal.qmd | 4 ++-- proposal/05-requirements.qmd | 12 ++++++------ 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 8353a18..8a96eaa 100644 --- a/README.md +++ b/README.md @@ -47,11 +47,11 @@ This is a boilerplate repository that you will need to fork, title appropriately - Use the "Use this template" button on GitHub - Create a new repository with a name to reflect your proposal -- Create a new Rstudio project from version control and use the git URL for the repo +- Create a new Positron/RStudio/IDE project from version control and use the git URL for the repo - Write an overview of the proposal instead of this boilerplate for the README -- Start completing the relevant Rmd pages of the proposal +- Start completing the relevant qmd pages of the proposal - Render `isc-proposal.qmd` to build the document locally -- Regularly commit and push the changes to github +- Regularly commit and push the changes to GitHub - Solicit feedback and contributions from others ### Automatically generate your proposal diff --git a/proposal/03-proposal.qmd b/proposal/03-proposal.qmd index 4129b6b..f5b6c4e 100644 --- a/proposal/03-proposal.qmd +++ b/proposal/03-proposal.qmd @@ -1,6 +1,6 @@ # The proposal ## Overview @@ -13,7 +13,7 @@ section. ## Detail @@ -9,21 +9,21 @@ Who needs to be involved, what's the proposed structure, what will it take to ge --> ## Processes - ## Tools & Tech ## Funding - @@ -31,4 +31,4 @@ Are there tools or tech that don't exist that will be produced to facilitate the ## Summary \ No newline at end of file +--> From 7ba8896ff7869f825621b74a9690fde733cc0a95 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kirill=20M=C3=BCller?= Date: Mon, 18 Aug 2025 19:45:04 +0200 Subject: [PATCH 4/8] Exec summary --- isc-proposal.qmd | 2 ++ proposal/00-exec-summary.qmd | 6 ++++++ 2 files changed, 8 insertions(+) create mode 100644 proposal/00-exec-summary.qmd diff --git a/isc-proposal.qmd b/isc-proposal.qmd index eef066f..1b96903 100644 --- a/isc-proposal.qmd +++ b/isc-proposal.qmd @@ -23,6 +23,8 @@ bibliography: references.bib This repository is currently being revisited. An update will be released in early September 2025. +{{< include proposal/00-exec-summary.qmd >}} + {{< include proposal/01-signatories.qmd >}} {{< include proposal/02-problemdefinition.qmd >}} diff --git a/proposal/00-exec-summary.qmd b/proposal/00-exec-summary.qmd new file mode 100644 index 0000000..9835e66 --- /dev/null +++ b/proposal/00-exec-summary.qmd @@ -0,0 +1,6 @@ +# Executive Summary + + From 105beb72fc865e8eb2c9f73f0c32832bca219cda Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kirill=20M=C3=BCller?= Date: Mon, 18 Aug 2025 19:49:52 +0200 Subject: [PATCH 5/8] Add Quarto project, closes #15 --- .gitignore | 2 ++ _quarto.yml | 5 +++++ 2 files changed, 7 insertions(+) create mode 100644 _quarto.yml diff --git a/.gitignore b/.gitignore index b462c78..7a2bf6a 100644 --- a/.gitignore +++ b/.gitignore @@ -16,3 +16,5 @@ vignettes/*.pdf # File gen artefacts *.html *.pdf + +/.quarto/ diff --git a/_quarto.yml b/_quarto.yml new file mode 100644 index 0000000..78e9c75 --- /dev/null +++ b/_quarto.yml @@ -0,0 +1,5 @@ +project: + title: "Isc-proposal" + render: + - "*.qmd" + - "!proposal/" From 96a6dbc28b0995c9bbbcfdffbb0fe2bb29405279 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kirill=20M=C3=BCller?= Date: Mon, 18 Aug 2025 19:55:10 +0200 Subject: [PATCH 6/8] Key Risks -> External dependencies --- proposal/03-proposal.qmd | 20 ++++++++++++++++++++ proposal/06-success.qmd | 21 +++++---------------- 2 files changed, 25 insertions(+), 16 deletions(-) diff --git a/proposal/03-proposal.qmd b/proposal/03-proposal.qmd index f5b6c4e..5f2f422 100644 --- a/proposal/03-proposal.qmd +++ b/proposal/03-proposal.qmd @@ -20,5 +20,25 @@ Depending on project type the detail section should include: --> ### Minimum Viable Product + + + ### Architecture + + + ### Assumptions + + + +### External dependencies + + diff --git a/proposal/06-success.qmd b/proposal/06-success.qmd index 336ba5e..637abb8 100644 --- a/proposal/06-success.qmd +++ b/proposal/06-success.qmd @@ -1,33 +1,22 @@ # Success - ## Definition of done - ## Measuring success - ## Future work - - -## Key risks - \ No newline at end of file From 9fcd20b8cde522e2154661c1346883ec50b13692 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kirill=20M=C3=BCller?= Date: Mon, 18 Aug 2025 20:18:38 +0200 Subject: [PATCH 7/8] Condense budget --- isc-proposal.qmd | 2 -- proposal/04-timeline.qmd | 2 ++ proposal/05-requirements.qmd | 34 ---------------------------------- 3 files changed, 2 insertions(+), 36 deletions(-) delete mode 100644 proposal/05-requirements.qmd diff --git a/isc-proposal.qmd b/isc-proposal.qmd index 1b96903..a2d67d9 100644 --- a/isc-proposal.qmd +++ b/isc-proposal.qmd @@ -33,8 +33,6 @@ An update will be released in early September 2025. {{< include proposal/04-timeline.qmd >}} -{{< include proposal/05-requirements.qmd >}} - {{< include proposal/06-success.qmd >}} ::: refs diff --git a/proposal/04-timeline.qmd b/proposal/04-timeline.qmd index 4211f06..6492bd8 100644 --- a/proposal/04-timeline.qmd +++ b/proposal/04-timeline.qmd @@ -34,3 +34,5 @@ facilitate successful delivery of the project. - [ ] UseR! - [ ] ISC meetings --> + +## Budget diff --git a/proposal/05-requirements.qmd b/proposal/05-requirements.qmd deleted file mode 100644 index 679252b..0000000 --- a/proposal/05-requirements.qmd +++ /dev/null @@ -1,34 +0,0 @@ -# Requirements - - -## People - - -## Processes - - -## Tools & Tech - - -## Funding - - -## Summary - From 5e3a745b1d9f8d2996938edfb88f51fc11402e9f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kirill=20M=C3=BCller?= Date: Mon, 18 Aug 2025 20:28:42 +0200 Subject: [PATCH 8/8] Align with list --- proposal/01-signatories.qmd | 13 +++++++------ proposal/02-problemdefinition.qmd | 8 +++++--- proposal/03-proposal.qmd | 6 ++++++ proposal/04-timeline.qmd | 27 ++++++++++++++++++++++++--- 4 files changed, 42 insertions(+), 12 deletions(-) diff --git a/proposal/01-signatories.qmd b/proposal/01-signatories.qmd index fe349f4..a9e3538 100644 --- a/proposal/01-signatories.qmd +++ b/proposal/01-signatories.qmd @@ -1,8 +1,8 @@ # Signatories - ## Project team - ## Contributors - ## Consulted - ``` diff --git a/proposal/03-proposal.qmd b/proposal/03-proposal.qmd index 5f2f422..89c1c43 100644 --- a/proposal/03-proposal.qmd +++ b/proposal/03-proposal.qmd @@ -1,5 +1,9 @@ # The proposal @@ -9,6 +13,8 @@ At a high-level address what your proposal is and how it will address the problem identified. Highlight any benefits to the R Community that follow from solving the problem. This should be your most compelling section. + +Include concrete actions you will take and estimated timeline. --> ## Detail diff --git a/proposal/04-timeline.qmd b/proposal/04-timeline.qmd index 6492bd8..002a723 100644 --- a/proposal/04-timeline.qmd +++ b/proposal/04-timeline.qmd @@ -23,10 +23,13 @@ and the ISC need to have a means of tracking delivery --> ## Other aspects + +## Budget & funding plan + + + ## Budget