Skip to content

Commit

Permalink
Merge pull request #569 from Crunch-io/style-changes-release-notes
Browse files Browse the repository at this point in the history
Edit markdown for release note 2025-02-03
  • Loading branch information
latechwriter authored Feb 4, 2025
2 parents 7e9d656 + 5ede3d3 commit 82d77b9
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions content/release-notes/2025-02-03.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,21 @@ 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:

**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.

### **Crunch Automation**

- Crunch Automation previously imposed a restriction on schema-breaking changes such as `drop` and `rename`, preventing common workflows such as variable deletion-and-re-creation. These restrictions have been relaxed, but users should exercise caution when making backward-incompatible changes that could render other variables or user artifacts invalid.

### **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.
- 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.

0 comments on commit 82d77b9

Please sign in to comment.