USEPA / CompTox-ToxCast-tcplFit2

Performs basic concentration response curve fitting
https://cran.r-project.org/package=tcplfit2
Other
1 stars 0 forks source link

Update README on CRAN #6

Closed kpaulfriedman closed 10 months ago

kpaulfriedman commented 11 months ago

Please update the README on CRAN for tcplfit2; it is specific to internal usage and not so helpful for external users. It also provides links to deprecated NCCT bitbucket and user details. It could use an update when the standalone vignette is added.

sedavid01 commented 10 months ago

Going to assign to @gracezhihuizhao to start on. Goal: Rename (archive) the current README file, and update current README with background information on package, requirements, and installation.

  1. Rename current README to old_README
  2. Create a new README file and include the following information:

Start with this for right now please.

@kpaulfriedman please let me know if there is additional information you would like to add to the current list or information in the current README you would like to retain.

@brown-jason and @sedavid01 can help to polish up the README (or provide additional guidance) when the basic information is included.

gracezhihuizhao commented 10 months ago

New README is pushed. @sedavid01 and @brown-jason please let me know your thoughts on the information and the format if you have a chance to review it. Thanks!

sedavid01 commented 10 months ago

Quick comment (@gracezhihuizhao): Please change Git/git (in text for READ ME file) to GitHub. Rationale: Distinguish between the repository where the package is stored (GitHub) from the actual version control software (Git).

sedavid01 commented 10 months ago

@brown-jason and @kpaulfriedman, this ticket has been completed and branch merged into 'dev'.