From a3718f4179a508560d84713c6d64752ee2fa03ce Mon Sep 17 00:00:00 2001 From: Natalia Suarez Date: Tue, 4 Feb 2025 18:55:40 +0000 Subject: [PATCH 1/2] edit markdown for release note --- content/release-notes/2025-02-03.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/content/release-notes/2025-02-03.md b/content/release-notes/2025-02-03.md index 5fc2cd958..b24af6327 100644 --- a/content/release-notes/2025-02-03.md +++ b/content/release-notes/2025-02-03.md @@ -19,15 +19,16 @@ images = ["https://crunch.io/img/logo-1200x630.png"] ### **SDKs (rCrunch, pyCrunch, and sCrunch)** -- There are two noteworthy API changes for users performing data processing tasks in Crunch: - 1. There is no longer a "Personal Project" to put datasets, which previously was the default place for creating datasets. This affects both creating/uploading new datasets, and making forks of existing ones. - - **Creating datasets**: The system won't know where to put a new dataset unless you specify a folder or "project". Going forward, rcrunch will by default error if you don't specify a project (either by a string path `newDataset(df, project = "/My Project/")`, or a project `newDataset(df, project = projects()[["My Project"]]))`. There is also an option to add a path to the environment variable `R_CRUNCH_DEFAULT_PROJECT` (or option `crunch.default.project`) to use when no project is specified. - - **Forking datasets**: Previously, forks were created in your personal project by default, unless the project was specified by URL. Going forward, they will be created in the same folder as the source dataset unless you specify a project as mentioned above. - - **Finding datasets by name**: As a consequence, finding a dataset by name (e.g., `loadDataset("ds name")`) will no longer be useful, because it only finds datasets in your personal project or shared via "direct share", which is also being deprecated. Instead, you must load datasets by ID/URL or with the path from a project. - 2. *Until further notice —* The ability to convert a "derived" variable into a "materialized" one is soft deprecated (e.g., via `is.derived(ds$var) <- FALSE`). Rcrunch is preparing for this by changing these behaviors now: - - **Creating variables**: Because we've seen that it's a common pattern to create a derived variable and then immediately convert it to materialized, it's now possible to set an environment variable (`R_CRUNCH_DEFAULT_DERIVED`) or the option `crunch.default.derived` to FALSE so that newly created variables are materialized from the start. It's also better documented in functions like `VarDef` and `deriveArray` that allow you to set the derive flag. - - **Updating `is.derived()`**: Will warn once per session that this is deprecated. - You can install now via `remotes::install_github("Crunch-io/rcrunch")` or it should make its way to CRAN in in the coming 2–6 weeks, depending on other items for the longer CRAN release cycle. +There are two noteworthy API changes for users performing data processing tasks in Crunch: + +**i.** There is no longer a "Personal Project" to put datasets, which previously was the default place for creating datasets. This affects both creating/uploading new datasets, and making forks of existing ones. + * **Creating datasets**: The system won't know where to put a new dataset unless you specify a folder or "project". Going forward, rcrunch will by default error if you don't specify a project (either by a string path `newDataset(df, project = "/My Project/")`, or a project `newDataset(df, project = projects()[["My Project"]]))`. There is also an option to add a path to the environment variable `R_CRUNCH_DEFAULT_PROJECT` (or option `crunch.default.project`) to use when no project is specified. + * **Forking datasets**: Previously, forks were created in your personal project by default, unless the project was specified by URL. Going forward, they will be created in the same folder as the source dataset unless you specify a project as mentioned above. + * **Finding datasets by name**: As a consequence, finding a dataset by name (e.g., `loadDataset("ds name")`) will no longer be useful, because it only finds datasets in your personal project or shared via "direct share", which is also being deprecated. Instead, you must load datasets by ID/URL or with the path from a project. + +**ii.** *Until further notice —* The ability to convert a "derived" variable into a "materialized" one is soft deprecated (e.g., via `is.derived(ds$var) <- FALSE`). Rcrunch is preparing for this by changing these behaviors now: + * **Creating variables**: Because we've seen that it's a common pattern to create a derived variable and then immediately convert it to materialized, it's now possible to set an environment variable (`R_CRUNCH_DEFAULT_DERIVED`) or the option `crunch.default.derived` to FALSE so that newly created variables are materialized from the start. It's also better documented in functions like `VarDef` and `deriveArray` that allow you to set the derive flag. + * **Updating `is.derived()`**: Will warn once per session that this is deprecated. You can install now via `remotes::install_github("Crunch-io/rcrunch")` or it should make its way to CRAN in in the coming 2–6 weeks, depending on other items for the longer CRAN release cycle. ### **Crunch Automation** @@ -35,4 +36,4 @@ images = ["https://crunch.io/img/logo-1200x630.png"] ### **Help desk and website improvements** -- Created a [new article](https://help.crunch.io/hc/en-us/articles/33292641414669-Crunch-Logical-Schema) that defines the canonical Crunch schema to support both existing and new datasets provided by Crunch users. \ No newline at end of file +- Created a [new article](https://help.crunch.io/hc/en-us/articles/33292641414669-Crunch-Logical-Schema) that defines the canonical Crunch schema to support both existing and new datasets provided by Crunch users. From 5ede3d3a0d96e363d3df646b4fe5a907851cedbe Mon Sep 17 00:00:00 2001 From: Natalia Suarez Date: Tue, 4 Feb 2025 19:07:13 +0000 Subject: [PATCH 2/2] Change roman numbers --- content/release-notes/2025-02-03.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/release-notes/2025-02-03.md b/content/release-notes/2025-02-03.md index b24af6327..722f8e77d 100644 --- a/content/release-notes/2025-02-03.md +++ b/content/release-notes/2025-02-03.md @@ -21,12 +21,12 @@ images = ["https://crunch.io/img/logo-1200x630.png"] There are two noteworthy API changes for users performing data processing tasks in Crunch: -**i.** There is no longer a "Personal Project" to put datasets, which previously was the default place for creating datasets. This affects both creating/uploading new datasets, and making forks of existing ones. +**1.** There is no longer a "Personal Project" to put datasets, which previously was the default place for creating datasets. This affects both creating/uploading new datasets, and making forks of existing ones. * **Creating datasets**: The system won't know where to put a new dataset unless you specify a folder or "project". Going forward, rcrunch will by default error if you don't specify a project (either by a string path `newDataset(df, project = "/My Project/")`, or a project `newDataset(df, project = projects()[["My Project"]]))`. There is also an option to add a path to the environment variable `R_CRUNCH_DEFAULT_PROJECT` (or option `crunch.default.project`) to use when no project is specified. * **Forking datasets**: Previously, forks were created in your personal project by default, unless the project was specified by URL. Going forward, they will be created in the same folder as the source dataset unless you specify a project as mentioned above. * **Finding datasets by name**: As a consequence, finding a dataset by name (e.g., `loadDataset("ds name")`) will no longer be useful, because it only finds datasets in your personal project or shared via "direct share", which is also being deprecated. Instead, you must load datasets by ID/URL or with the path from a project. -**ii.** *Until further notice —* The ability to convert a "derived" variable into a "materialized" one is soft deprecated (e.g., via `is.derived(ds$var) <- FALSE`). Rcrunch is preparing for this by changing these behaviors now: +**2.** *Until further notice —* The ability to convert a "derived" variable into a "materialized" one is soft deprecated (e.g., via `is.derived(ds$var) <- FALSE`). Rcrunch is preparing for this by changing these behaviors now: * **Creating variables**: Because we've seen that it's a common pattern to create a derived variable and then immediately convert it to materialized, it's now possible to set an environment variable (`R_CRUNCH_DEFAULT_DERIVED`) or the option `crunch.default.derived` to FALSE so that newly created variables are materialized from the start. It's also better documented in functions like `VarDef` and `deriveArray` that allow you to set the derive flag. * **Updating `is.derived()`**: Will warn once per session that this is deprecated. You can install now via `remotes::install_github("Crunch-io/rcrunch")` or it should make its way to CRAN in in the coming 2–6 weeks, depending on other items for the longer CRAN release cycle.