Skip to content

Commit b67fe3c

Browse files
authored
Revise README structure and content
1 parent 4df0322 commit b67fe3c

1 file changed

Lines changed: 13 additions & 15 deletions

File tree

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,23 @@
1-
# Template R operator
1+
# Template R Operator
22

3-
The `Template R operator` is a template repository for the creation of R operators in Tercen. An overview of steps for developing an operator are:
3+
The `Template R Operator` is a template repository for the creation of R operators in Tercen. An overview of steps for developing an operator are:
44

5-
1. create a github repo
6-
2. install tercen_studio
7-
3. login to tercen_studio
8-
4. git clone the newly created repo
9-
5. start developing in R in tercen_studio
10-
6. add R packages to the repo
11-
7. push to the github repo
12-
8. go to tercen and install the operator
5+
1. Create a new GitHub repository using this template
6+
2. Clone the newly created repository to your development environment (we recommend using VS Code)
7+
3. Describe your operator specifications in the README file
8+
4. Develop the operator (with or without assistance from the Tercen Agents)
9+
5. Initialise or update the R packages environment using `renv`.
10+
6. Push your changes and install the operator in Tercen
1311

14-
More information can be found in [Tercen developer's guide](https://tercen.github.io/developers_guide/).
12+
Detailed information can be found in the [Tercen developer's guide](https://tercen.github.io/developers_guide/).
1513

16-
Below is the operator README standard structure:
14+
Below is the operator README standard structure.
1715

18-
##### Description
16+
### Description
1917

2018
The `Template R operator` is a template repository for the creation of R operators in Tercen.
2119

22-
##### Usage
20+
### Usage
2321

2422
Input|.
2523
---|---
@@ -39,6 +37,6 @@ Output|.
3937
`output_var` | output relation
4038
`Operator view` | view of the Shiny application
4139

42-
##### Details
40+
### Details
4341

4442
Details on the computation.

0 commit comments

Comments
 (0)